C# Class kasthack.vksharp.Api.MethodGroup_Users

Show file Open project: kasthack/kasthack.vksharp

Public Methods

Method Description
Get ( UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom ) : Task
GetFollowers ( int userId = null, UserFields fields = UserFields.Anything, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
GetFollowers ( int userId = null, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
GetFollowersSync ( int userId = null, UserFields fields = UserFields.Anything, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
GetFollowersSync ( int userId = null, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
GetNearby ( double latitude, double longitude, int accuracy = null, int timeout = null, byte radius = null, UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
GetNearbySync ( double latitude, double longitude, int accuracy = null, int timeout = null, byte radius = null, UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
GetSubscriptions ( int userId = null, int offset = null, int count = 100 ) : Task

Возвращает список идентификаторов пользователей и сообществ, которые входят в список подписок пользователя
GetSubscriptionsSync ( int userId = null, int offset = null, int count = 100 ) : UserSubscriptions

Возвращает список идентификаторов пользователей и сообществ, которые входят в список подписок пользователя
GetSync ( UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom ) : User[]
IsAppUser ( int userId = null ) : Task

Возвращает информацию о том, установил ли пользователь приложение
IsAppUserSync ( int userId = null ) : bool

Возвращает информацию о том, установил ли пользователь приложение
Report ( int userId, ComplaintType type, string comment ) : System.Threading.Tasks.Task

Позволяет пожаловаться на пользователя
ReportSync ( int userId, ComplaintType type, string comment ) : void

Позволяет пожаловаться на пользователя
Search ( string q = "", SearchSortOrder sort = SearchSortOrder.ByRating, UserFields fields = UserFields.None, int city = null, int country = null, string hometown = "", int universityCountry = null, int university = null, int universityYear = null, int universityFaculty = null, int universityChair = null, Sex sex = null, Relation status = null, byte ageFrom = null, byte ageTo = null, byte birthDay = null, byte birthMonth = null, ushort birthYear = null, bool online = null, bool hasPhoto = null, int schoolCountry = null, int schoolCity = null, int schoolClass = null, int school = null, int schoolYear = null, string religion = "", string interests = "", string company = "", string position = "", int groupId = null, FriendshipType fromList = null, int offset = null, int count = 100 ) : Task>

Возвращает список пользователей в соответствии с заданным критерием поиска
SearchSync ( string q = "", SearchSortOrder sort = SearchSortOrder.ByRating, UserFields fields = UserFields.None, int city = null, int country = null, string hometown = "", int universityCountry = null, int university = null, int universityYear = null, int universityFaculty = null, int universityChair = null, Sex sex = null, Relation status = null, byte ageFrom = null, byte ageTo = null, byte birthDay = null, byte birthMonth = null, ushort birthYear = null, bool online = null, bool hasPhoto = null, int schoolCountry = null, int schoolCity = null, int schoolClass = null, int school = null, int schoolYear = null, string religion = "", string interests = "", string company = "", string position = "", int groupId = null, FriendshipType fromList = null, int offset = null, int count = 100 ) : EntityList

Возвращает список пользователей в соответствии с заданным критерием поиска

Private Methods

Method Description
MethodGroup_Users ( Api parent ) : System

Method Details

Get() public method

public Get ( UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom ) : Task
fields UserFields
nameCase NameCase
return Task

GetFollowers() public method

public GetFollowers ( int userId = null, UserFields fields = UserFields.Anything, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
userId int
fields UserFields
nameCase NameCase
offset int
count int
return Task>

GetFollowers() public method

public GetFollowers ( int userId = null, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
userId int
nameCase NameCase
offset int
count int
return Task>

GetFollowersSync() public method

public GetFollowersSync ( int userId = null, UserFields fields = UserFields.Anything, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
userId int
fields UserFields
nameCase NameCase
offset int
count int
return EntityList

GetFollowersSync() public method

public GetFollowersSync ( int userId = null, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
userId int
nameCase NameCase
offset int
count int
return EntityList

GetNearby() public method

public GetNearby ( double latitude, double longitude, int accuracy = null, int timeout = null, byte radius = null, UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : Task>
latitude double
longitude double
accuracy int
timeout int
radius byte
fields UserFields
nameCase NameCase
offset int
count int
return Task>

GetNearbySync() public method

public GetNearbySync ( double latitude, double longitude, int accuracy = null, int timeout = null, byte radius = null, UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom, int offset = null, int count = 100 ) : EntityList
latitude double
longitude double
accuracy int
timeout int
radius byte
fields UserFields
nameCase NameCase
offset int
count int
return EntityList

GetSubscriptions() public method

Возвращает список идентификаторов пользователей и сообществ, которые входят в список подписок пользователя
public GetSubscriptions ( int userId = null, int offset = null, int count = 100 ) : Task
userId int идентификатор пользователя
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
return Task

GetSubscriptionsSync() public method

Возвращает список идентификаторов пользователей и сообществ, которые входят в список подписок пользователя
public GetSubscriptionsSync ( int userId = null, int offset = null, int count = 100 ) : UserSubscriptions
userId int идентификатор пользователя
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
return kasthack.vksharp.DataTypes.Entities.UserSubscriptions

GetSync() public method

public GetSync ( UserFields fields = UserFields.None, NameCase nameCase = NameCase.Nom ) : User[]
fields UserFields
nameCase NameCase
return User[]

IsAppUser() public method

Возвращает информацию о том, установил ли пользователь приложение
public IsAppUser ( int userId = null ) : Task
userId int идентификатор пользователя
return Task

IsAppUserSync() public method

Возвращает информацию о том, установил ли пользователь приложение
public IsAppUserSync ( int userId = null ) : bool
userId int идентификатор пользователя
return bool

Report() public method

Позволяет пожаловаться на пользователя
public Report ( int userId, ComplaintType type, string comment ) : System.Threading.Tasks.Task
userId int идентификатор пользователя, на которого нужно подать жалобу
type ComplaintType тип жалобы
comment string комментарий к жалобе на пользователя
return System.Threading.Tasks.Task

ReportSync() public method

Позволяет пожаловаться на пользователя
public ReportSync ( int userId, ComplaintType type, string comment ) : void
userId int идентификатор пользователя, на которого нужно подать жалобу
type ComplaintType тип жалобы
comment string комментарий к жалобе на пользователя
return void

Search() public method

Возвращает список пользователей в соответствии с заданным критерием поиска
public Search ( string q = "", SearchSortOrder sort = SearchSortOrder.ByRating, UserFields fields = UserFields.None, int city = null, int country = null, string hometown = "", int universityCountry = null, int university = null, int universityYear = null, int universityFaculty = null, int universityChair = null, Sex sex = null, Relation status = null, byte ageFrom = null, byte ageTo = null, byte birthDay = null, byte birthMonth = null, ushort birthYear = null, bool online = null, bool hasPhoto = null, int schoolCountry = null, int schoolCity = null, int schoolClass = null, int school = null, int schoolYear = null, string religion = "", string interests = "", string company = "", string position = "", int groupId = null, FriendshipType fromList = null, int offset = null, int count = 100 ) : Task>
q string строка поискового запроса
sort SearchSortOrder порядок сортировки
fields UserFields список дополнительных полей профилей, которые необходимо вернуть
city int идентификатор города
country int идентификатор страны
hometown string название города строкой
universityCountry int идентификатор страны, в которой пользователи закончили ВУЗ
university int идентификатор ВУЗа
universityYear int год окончания ВУЗа
universityFaculty int идентификатор факультета
universityChair int идентификатор кафедры
sex Sex пол
status Relation семейное положение
ageFrom byte начиная с какого возраста
ageTo byte до какого возраста
birthDay byte день рождения
birthMonth byte месяц рождения
birthYear ushort год рождения
online bool только в сети
hasPhoto bool только с фотографией
schoolCountry int идентификатор страны, в которой пользователи закончили школу
schoolCity int идентификатор города, в котором пользователи закончили школу
schoolClass int
school int идентификатор школы, которую закончили пользователи
schoolYear int год окончания школы
religion string религиозные взгляды
interests string интересы
company string название компании, в которой работают пользователи
position string название должности
groupId int идентификатор группы, среди пользователей которой необходимо проводить поиск
fromList FriendshipType Разделы среди которых нужно осуществить поиск
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
return Task>

SearchSync() public method

Возвращает список пользователей в соответствии с заданным критерием поиска
public SearchSync ( string q = "", SearchSortOrder sort = SearchSortOrder.ByRating, UserFields fields = UserFields.None, int city = null, int country = null, string hometown = "", int universityCountry = null, int university = null, int universityYear = null, int universityFaculty = null, int universityChair = null, Sex sex = null, Relation status = null, byte ageFrom = null, byte ageTo = null, byte birthDay = null, byte birthMonth = null, ushort birthYear = null, bool online = null, bool hasPhoto = null, int schoolCountry = null, int schoolCity = null, int schoolClass = null, int school = null, int schoolYear = null, string religion = "", string interests = "", string company = "", string position = "", int groupId = null, FriendshipType fromList = null, int offset = null, int count = 100 ) : EntityList
q string строка поискового запроса
sort SearchSortOrder порядок сортировки
fields UserFields список дополнительных полей профилей, которые необходимо вернуть
city int идентификатор города
country int идентификатор страны
hometown string название города строкой
universityCountry int идентификатор страны, в которой пользователи закончили ВУЗ
university int идентификатор ВУЗа
universityYear int год окончания ВУЗа
universityFaculty int идентификатор факультета
universityChair int идентификатор кафедры
sex Sex пол
status Relation семейное положение
ageFrom byte начиная с какого возраста
ageTo byte до какого возраста
birthDay byte день рождения
birthMonth byte месяц рождения
birthYear ushort год рождения
online bool только в сети
hasPhoto bool только с фотографией
schoolCountry int идентификатор страны, в которой пользователи закончили школу
schoolCity int идентификатор города, в котором пользователи закончили школу
schoolClass int
school int идентификатор школы, которую закончили пользователи
schoolYear int год окончания школы
religion string религиозные взгляды
interests string интересы
company string название компании, в которой работают пользователи
position string название должности
groupId int идентификатор группы, среди пользователей которой необходимо проводить поиск
fromList FriendshipType Разделы среди которых нужно осуществить поиск
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
return EntityList