vkapi

package
v0.0.0-...-8375398 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 26, 2022 License: MIT Imports: 7 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	API vk.API
}

Account implements VK API namespace `account`

func (Account) Ban

func (v Account) Ban(params AccountBanParams) (bool, error)

Ban does account.ban

func (Account) ChangePassword

ChangePassword Changes a user password after access is successfully restored with the [vk.com/dev/auth.restore|auth.restore] method.

func (Account) GetActiveOffers

GetActiveOffers Returns a list of active ads (offers) which executed by the user will bring him/her respective number of votes to his balance in the application.

func (Account) GetAppPermissions

GetAppPermissions Gets settings of the user in this application.

func (Account) GetBanned

GetBanned Returns a user's blacklist.

func (Account) GetCounters

GetCounters Returns non-null values of user counters.

func (Account) GetInfo

GetInfo Returns current account info.

func (Account) GetProfileInfo

func (v Account) GetProfileInfo() (*AccountGetProfileInfoResponse, error)

GetProfileInfo Returns the current account info.

func (Account) GetPushSettings

GetPushSettings Gets settings of push notifications.

func (Account) RegisterDevice

func (v Account) RegisterDevice(params AccountRegisterDeviceParams) (bool, error)

RegisterDevice Subscribes an iOS/Android/Windows Phone-based device to receive push notifications

func (Account) SaveProfileInfo

SaveProfileInfo Edits current profile info.

func (Account) SetInfo

func (v Account) SetInfo(params AccountSetInfoParams) (bool, error)

SetInfo Allows to edit the current account info.

func (Account) SetNameInMenu

func (v Account) SetNameInMenu(params AccountSetNameInMenuParams) (bool, error)

SetNameInMenu Sets an application screen name (up to 17 characters), that is shown to the user in the left menu.

func (Account) SetOffline

func (v Account) SetOffline() (bool, error)

SetOffline Marks a current user as offline.

func (Account) SetOnline

func (v Account) SetOnline(params AccountSetOnlineParams) (bool, error)

SetOnline Marks the current user as online for 15 minutes.

func (Account) SetPushSettings

func (v Account) SetPushSettings(params AccountSetPushSettingsParams) (bool, error)

SetPushSettings Change push settings.

func (Account) SetSilenceMode

func (v Account) SetSilenceMode(params AccountSetSilenceModeParams) (bool, error)

SetSilenceMode Mutes push notifications for the set period of time.

func (Account) Unban

func (v Account) Unban(params AccountUnbanParams) (bool, error)

Unban does account.unban

func (Account) UnregisterDevice

func (v Account) UnregisterDevice(params AccountUnregisterDeviceParams) (bool, error)

UnregisterDevice Unsubscribes a device from push notifications.

type AccountBanParams

type AccountBanParams struct {
	OwnerID int `url:"owner_id,omitempty"`
}

AccountBanParams are params for Account.Ban

type AccountChangePasswordParams

type AccountChangePasswordParams struct {
	// Session id received after the [vk.com/dev/auth.restore|auth.restore] method is executed. (If the password is changed right after the access was restored)
	RestoreSid string `url:"restore_sid,omitempty"`
	// Hash received after a successful OAuth authorization with a code got by SMS. (If the password is changed right after the access was restored)
	ChangePasswordHash string `url:"change_password_hash,omitempty"`
	// Current user password.
	OldPassword string `url:"old_password,omitempty"`
	// New password that will be set as a current
	NewPassword string `url:"new_password"`
}

AccountChangePasswordParams are params for Account.ChangePassword

type AccountChangePasswordResponse

type AccountChangePasswordResponse struct {
	// New token
	Token string `json:"token,omitempty"`
	// New secret
	Secret string `json:"secret,omitempty"`
}

AccountChangePasswordResponse is response for Account.ChangePassword

type AccountGetActiveOffersParams

type AccountGetActiveOffersParams struct {
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
}

AccountGetActiveOffersParams are params for Account.GetActiveOffers

type AccountGetActiveOffersResponse

type AccountGetActiveOffersResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Offer ID
		ID int `json:"id,omitempty"`
		// Offer title
		Title string `json:"title,omitempty"`
		// Instruction how to process the offer
		Instruction string `json:"instruction,omitempty"`
		// Instruction how to process the offer (HTML format)
		InstructionHTML string `json:"instruction_html,omitempty"`
		// Offer short description
		ShortDescription string `json:"short_description,omitempty"`
		// Offer description
		Description string `json:"description,omitempty"`
		// URL of the preview image
		Img string `json:"img,omitempty"`
		// Offer tag
		Tag string `json:"tag,omitempty"`
		// Offer price
		Price int `json:"price,omitempty"`
	} `json:"items,omitempty"`
}

AccountGetActiveOffersResponse is response for Account.GetActiveOffers

type AccountGetAppPermissionsParams

type AccountGetAppPermissionsParams struct {
	// User ID whose settings information shall be got. By default: current user.
	UserID int `url:"user_id"`
}

AccountGetAppPermissionsParams are params for Account.GetAppPermissions

type AccountGetAppPermissionsResponse

type AccountGetAppPermissionsResponse int

AccountGetAppPermissionsResponse is response for Account.GetAppPermissions Permissions mask

type AccountGetBannedParams

type AccountGetBannedParams struct {
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
}

AccountGetBannedParams are params for Account.GetBanned

type AccountGetBannedResponse

type AccountGetBannedResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

AccountGetBannedResponse is response for Account.GetBanned

type AccountGetCountersParams

type AccountGetCountersParams struct {
	// Counters to be returned.
	Filter CSVStringSlice `url:"filter,omitempty"`
}

AccountGetCountersParams are params for Account.GetCounters

type AccountGetCountersResponse

type AccountGetCountersResponse struct {
	// New friends requests number
	Friends int `json:"friends,omitempty"`
	// New messages number
	Messages int `json:"messages,omitempty"`
	// New photo tags number
	Photos int `json:"photos,omitempty"`
	// New video tags number
	Videos int `json:"videos,omitempty"`
	// New gifts number
	Gifts int `json:"gifts,omitempty"`
	// New events number
	Events int `json:"events,omitempty"`
	// New groups number
	Groups int `json:"groups,omitempty"`
	// New notifications number
	Notifications int `json:"notifications,omitempty"`
	// New app requests number
	AppRequests int `json:"app_requests,omitempty"`
	// New friends suggestions number
	FriendsSuggestions int `json:"friends_suggestions,omitempty"`
}

AccountGetCountersResponse is response for Account.GetCounters

type AccountGetInfoParams

type AccountGetInfoParams struct {
	// Fields to return. Possible values: *'country' — user country,, *'https_required' — is "HTTPS only" option enabled,, *'own_posts_default' — is "Show my posts only" option is enabled,, *'no_wall_replies' — are wall replies disabled or not,, *'intro' — is intro passed by user or not,, *'lang' — user language. By default: all.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

AccountGetInfoParams are params for Account.GetInfo

type AccountGetInfoResponse

type AccountGetInfoResponse struct {
	// Country code
	Country string `json:"country,omitempty"`
	// Information whether HTTPS-only is enabled
	HTTPSRequired vk.BoolInt `json:"https_required,omitempty"`
	// Information whether only owners posts should be shown
	OwnPostsDefault vk.BoolInt `json:"own_posts_default,omitempty"`
	// Information whether wall comments should be hidden
	NoWallReplies vk.BoolInt `json:"no_wall_replies,omitempty"`
	// Information whether user has been processed intro
	Intro vk.BoolInt `json:"intro,omitempty"`
	// Language ID
	Lang int `json:"lang,omitempty"`
	// Two factor authentication is enabled
	X2FaRequired vk.BoolInt `json:"2fa_required,omitempty"`
}

AccountGetInfoResponse is response for Account.GetInfo

type AccountGetProfileInfoResponse

type AccountGetProfileInfoResponse struct {
	// User first name
	FirstName string `json:"first_name,omitempty"`
	// User last name
	LastName string `json:"last_name,omitempty"`
	// User maiden name
	MaidenName string `json:"maiden_name,omitempty"`
	// Domain name of the user's page
	ScreenName string `json:"screen_name,omitempty"`
	// User sex
	Sex int `json:"sex,omitempty"`
	// User relationship status
	Relation        int     `json:"relation,omitempty"`
	RelationPartner vk.User `json:"relation_partner,omitempty"`
	// Information whether relation status is pending
	RelationPending  int       `json:"relation_pending,omitempty"`
	RelationRequests []vk.User `json:"relation_requests,omitempty"`
	// User's date of birth
	Bdate string `json:"bdate,omitempty"`
	// Information whether user's birthdate are hidden
	BdateVisibility int `json:"bdate_visibility,omitempty"`
	// User's hometown
	HomeTown string        `json:"home_town,omitempty"`
	Country  vk.BaseObject `json:"country,omitempty"`
	City     vk.BaseObject `json:"city,omitempty"`
	// User status
	Status string `json:"status,omitempty"`
	// User phone number with some hidden digits
	Phone       string `json:"phone,omitempty"`
	NameRequest struct {
		// Request ID needed to cancel the request
		ID int `json:"id,omitempty"`
		// Request status
		Status string `json:"status,omitempty"`
		// First name in request
		FirstName string `json:"first_name,omitempty"`
		// Last name in request
		LastName string `json:"last_name,omitempty"`
	} `json:"name_request,omitempty"`
}

AccountGetProfileInfoResponse is response for Account.GetProfileInfo

type AccountGetPushSettingsParams

type AccountGetPushSettingsParams struct {
	// Unique device ID.
	DeviceID string `url:"device_id,omitempty"`
}

AccountGetPushSettingsParams are params for Account.GetPushSettings

type AccountGetPushSettingsResponse

type AccountGetPushSettingsResponse struct {
	// Information whether notifications are disabled
	Disabled vk.BoolInt `json:"disabled,omitempty"`
	// Time until that notifications are disabled in Unixtime
	DisabledUntil int `json:"disabled_until,omitempty"`
	Conversations struct {
		// Items count
		Count int `json:"count,omitempty"`
		Items []struct {
			// Peer ID
			PeerID int `json:"peer_id,omitempty"`
			// Information whether the sound are enabled
			Sound vk.BoolInt `json:"sound,omitempty"`
			// Time until that notifications are disabled in seconds
			DisabledUntil int `json:"disabled_until,omitempty"`
		} `json:"items,omitempty"`
	} `json:"conversations,omitempty"`
	Settings struct {
		// Settings parameters
		Msg []string `json:"msg,omitempty"`
		// Settings parameters
		Chat []string `json:"chat,omitempty"`
		// Settings parameters
		Friend []string `json:"friend,omitempty"`
		// Settings parameters
		FriendFound []string `json:"friend_found,omitempty"`
		// Settings parameters
		FriendAccepted []string `json:"friend_accepted,omitempty"`
		// Settings parameters
		Reply []string `json:"reply,omitempty"`
		// Settings parameters
		Comment []string `json:"comment,omitempty"`
		// Settings parameters
		Mention []string `json:"mention,omitempty"`
		// Settings parameters
		Like []string `json:"like,omitempty"`
		// Settings parameters
		Repost []string `json:"repost,omitempty"`
		// Settings parameters
		WallPost []string `json:"wall_post,omitempty"`
		// Settings parameters
		WallPublish []string `json:"wall_publish,omitempty"`
		// Settings parameters
		GroupInvite []string `json:"group_invite,omitempty"`
		// Settings parameters
		GroupAccepted []string `json:"group_accepted,omitempty"`
		// Settings parameters
		EventSoon []string `json:"event_soon,omitempty"`
		// Settings parameters
		PhotosTag []string `json:"photos_tag,omitempty"`
		// Settings parameters
		AppRequest []string `json:"app_request,omitempty"`
		// Settings parameters
		SdkOpen []string `json:"sdk_open,omitempty"`
		// Settings parameters
		NewPost []string `json:"new_post,omitempty"`
		// Settings parameters
		Birthday []string `json:"birthday,omitempty"`
	} `json:"settings,omitempty"`
}

AccountGetPushSettingsResponse is response for Account.GetPushSettings

type AccountRegisterDeviceParams

type AccountRegisterDeviceParams struct {
	// Device token used to send notifications. (for mpns, the token shall be URL for sending of notifications)
	Token string `url:"token"`
	// String name of device model.
	DeviceModel string `url:"device_model,omitempty"`
	// Device year.
	DeviceYear int `url:"device_year,omitempty"`
	// Unique device ID.
	DeviceID string `url:"device_id"`
	// String version of device operating system.
	SystemVersion string `url:"system_version,omitempty"`
	// Push settings in a [vk.com/dev/push_settings|special format].
	Settings string `url:"settings,omitempty"`
	Sandbox  bool   `url:"sandbox,omitempty"`
}

AccountRegisterDeviceParams are params for Account.RegisterDevice

type AccountSaveProfileInfoParams

type AccountSaveProfileInfoParams struct {
	// User first name.
	FirstName string `url:"first_name,omitempty"`
	// User last name.
	LastName string `url:"last_name,omitempty"`
	// User maiden name (female only)
	MaidenName string `url:"maiden_name,omitempty"`
	// User screen name.
	ScreenName string `url:"screen_name,omitempty"`
	// ID of the name change request to be canceled. If this parameter is sent, all the others are ignored.
	CancelRequestID int `url:"cancel_request_id,omitempty"`
	// User sex. Possible values: , * '1' – female,, * '2' – male.
	Sex int `url:"sex,omitempty"`
	// User relationship status. Possible values: , * '1' – single,, * '2' – in a relationship,, * '3' – engaged,, * '4' – married,, * '5' – it's complicated,, * '6' – actively searching,, * '7' – in love,, * '0' – not specified.
	Relation int `url:"relation,omitempty"`
	// ID of the relationship partner.
	RelationPartnerID int `url:"relation_partner_id,omitempty"`
	// User birth date, format: DD.MM.YYYY.
	Bdate string `url:"bdate,omitempty"`
	// Birth date visibility. Returned values: , * '1' – show birth date,, * '2' – show only month and day,, * '0' – hide birth date.
	BdateVisibility int `url:"bdate_visibility,omitempty"`
	// User home town.
	HomeTown string `url:"home_town,omitempty"`
	// User country.
	CountryID int `url:"country_id,omitempty"`
	// User city.
	CityID int `url:"city_id,omitempty"`
	// Status text.
	Status string `url:"status,omitempty"`
}

AccountSaveProfileInfoParams are params for Account.SaveProfileInfo

type AccountSaveProfileInfoResponse

type AccountSaveProfileInfoResponse struct {
	// 1 if changes has been processed
	Changed     vk.BoolInt `json:"changed,omitempty"`
	NameRequest struct {
		// Request ID needed to cancel the request
		ID int `json:"id,omitempty"`
		// Request status
		Status string `json:"status,omitempty"`
		// First name in request
		FirstName string `json:"first_name,omitempty"`
		// Last name in request
		LastName string `json:"last_name,omitempty"`
	} `json:"name_request,omitempty"`
}

AccountSaveProfileInfoResponse is response for Account.SaveProfileInfo

type AccountSetInfoParams

type AccountSetInfoParams struct {
	// Setting name.
	Name string `url:"name,omitempty"`
	// Setting value.
	Value string `url:"value,omitempty"`
}

AccountSetInfoParams are params for Account.SetInfo

type AccountSetNameInMenuParams

type AccountSetNameInMenuParams struct {
	// User ID.
	UserID int `url:"user_id"`
	// Application screen name.
	Name string `url:"name,omitempty"`
}

AccountSetNameInMenuParams are params for Account.SetNameInMenu

type AccountSetOnlineParams

type AccountSetOnlineParams struct {
	// '1' if videocalls are available for current device.
	Voip bool `url:"voip,omitempty"`
}

AccountSetOnlineParams are params for Account.SetOnline

type AccountSetPushSettingsParams

type AccountSetPushSettingsParams struct {
	// Unique device ID.
	DeviceID string `url:"device_id"`
	// Push settings in a [vk.com/dev/push_settings|special format].
	Settings string `url:"settings,omitempty"`
	// Notification key.
	Key string `url:"key,omitempty"`
	// New value for the key in a [vk.com/dev/push_settings|special format].
	Value CSVStringSlice `url:"value,omitempty"`
}

AccountSetPushSettingsParams are params for Account.SetPushSettings

type AccountSetSilenceModeParams

type AccountSetSilenceModeParams struct {
	// Unique device ID.
	DeviceID string `url:"device_id,omitempty"`
	// Time in seconds for what notifications should be disabled. '-1' to disable forever.
	Time int `url:"time,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// '1' — to enable sound in this dialog, '0' — to disable sound. Only if 'peer_id' contains user or community ID.
	Sound int `url:"sound,omitempty"`
}

AccountSetSilenceModeParams are params for Account.SetSilenceMode

type AccountUnbanParams

type AccountUnbanParams struct {
	OwnerID int `url:"owner_id,omitempty"`
}

AccountUnbanParams are params for Account.Unban

type AccountUnregisterDeviceParams

type AccountUnregisterDeviceParams struct {
	// Unique device ID.
	DeviceID string `url:"device_id,omitempty"`
	Sandbox  bool   `url:"sandbox,omitempty"`
}

AccountUnregisterDeviceParams are params for Account.UnregisterDevice

type Apps

type Apps struct {
	API vk.API
}

Apps implements VK API namespace `apps`

func (Apps) DeleteAppRequests

func (v Apps) DeleteAppRequests() (bool, error)

DeleteAppRequests Deletes all request notifications from the current app.

func (Apps) Get

func (v Apps) Get(params AppsGetParams) (*AppsGetResponse, error)

Get Returns applications data.

func (Apps) GetCatalog

func (v Apps) GetCatalog(params AppsGetCatalogParams) (*AppsGetCatalogResponse, error)

GetCatalog Returns a list of applications (apps) available to users in the App Catalog.

func (Apps) GetFriendsList

func (v Apps) GetFriendsList(params AppsGetFriendsListParams) (*AppsGetFriendsListResponse, error)

GetFriendsList Creates friends list for requests and invites in current app.

func (Apps) GetLeaderboard

func (v Apps) GetLeaderboard(params AppsGetLeaderboardParams) (AppsGetLeaderboardResponse, error)

GetLeaderboard Returns players rating in the game.

func (Apps) GetScopes

func (v Apps) GetScopes(params AppsGetScopesParams) (*AppsGetScopesResponse, error)

GetScopes Returns scopes for auth

func (Apps) GetScore

func (v Apps) GetScore(params AppsGetScoreParams) (AppsGetScoreResponse, error)

GetScore Returns user score in app

func (Apps) SendRequest

func (v Apps) SendRequest(params AppsSendRequestParams) (AppsSendRequestResponse, error)

SendRequest Sends a request to another user in an app that uses VK authorization.

type AppsGetCatalogParams

type AppsGetCatalogParams struct {
	// Sort order: 'popular_today' — popular for one day (default), 'visitors' — by visitors number , 'create_date' — by creation date, 'growth_rate' — by growth rate, 'popular_week' — popular for one week
	Sort string `url:"sort,omitempty"`
	// Offset required to return a specific subset of apps.
	Offset int `url:"offset,omitempty"`
	// Number of apps to return.
	Count    int    `url:"count"`
	Platform string `url:"platform,omitempty"`
	// '1' — to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'. If set, 'count' must be less than or equal to '100'. '0' — not to return additional fields (default).
	Extended      bool           `url:"extended,omitempty"`
	ReturnFriends bool           `url:"return_friends,omitempty"`
	Fields        CSVStringSlice `url:"fields,omitempty"`
	NameCase      string         `url:"name_case,omitempty"`
	// Search query string.
	Q       string `url:"q,omitempty"`
	GenreID int    `url:"genre_id,omitempty"`
	// 'installed' — to return list of installed apps (only for mobile platform).
	Filter string `url:"filter,omitempty"`
}

AppsGetCatalogParams are params for Apps.GetCatalog

type AppsGetCatalogResponse

type AppsGetCatalogResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

AppsGetCatalogResponse is response for Apps.GetCatalog

type AppsGetFriendsListParams

type AppsGetFriendsListParams struct {
	Extended bool `url:"extended,omitempty"`
	// List size.
	Count  int `url:"count,omitempty"`
	Offset int `url:"offset,omitempty"`
	// List type. Possible values: * 'invite' — available for invites (don't play the game),, * 'request' — available for request (play the game). By default: 'invite'.
	Type string `url:"type,omitempty"`
	// Additional profile fields, see [vk.com/dev/fields|description].
	Fields CSVStringSlice `url:"fields,omitempty"`
}

AppsGetFriendsListParams are params for Apps.GetFriendsList

type AppsGetFriendsListResponse

type AppsGetFriendsListResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

AppsGetFriendsListResponse is response for Apps.GetFriendsList

type AppsGetLeaderboardParams

type AppsGetLeaderboardParams struct {
	// Leaderboard type. Possible values: *'level' — by level,, *'points' — by mission points,, *'score' — by score ().
	Type string `url:"type"`
	// Rating type. Possible values: *'1' — global rating among all players,, *'0' — rating among user friends.
	Global bool `url:"global,omitempty"`
	// 1 — to return additional info about users
	Extended bool `url:"extended,omitempty"`
}

AppsGetLeaderboardParams are params for Apps.GetLeaderboard

type AppsGetLeaderboardResponse

type AppsGetLeaderboardResponse interface {
	// contains filtered or unexported methods
}

AppsGetLeaderboardResponse is response for Apps.GetLeaderboard Either AppsGetLeaderboardResponseNormal or AppsGetLeaderboardResponseExtended, depending on Extended flag

type AppsGetLeaderboardResponseExtended

type AppsGetLeaderboardResponseExtended struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Score number
		Score int `json:"score,omitempty"`
		// Level
		Level int `json:"level,omitempty"`
		// Points number
		Points int `json:"points,omitempty"`
		// User ID
		UserID int `json:"user_id,omitempty"`
	} `json:"items,omitempty"`
	Profiles []vk.User `json:"profiles,omitempty"`
}

AppsGetLeaderboardResponseExtended is extended version of AppsGetLeaderboardResponse

type AppsGetLeaderboardResponseNormal

type AppsGetLeaderboardResponseNormal struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Score number
		Score int `json:"score,omitempty"`
		// Level
		Level int `json:"level,omitempty"`
		// Points number
		Points int `json:"points,omitempty"`
		// User ID
		UserID int `json:"user_id,omitempty"`
	} `json:"items,omitempty"`
}

AppsGetLeaderboardResponseNormal is non-extended version of AppsGetLeaderboardResponse

type AppsGetParams

type AppsGetParams struct {
	// Application ID
	AppID int `url:"app_id,omitempty"`
	// List of application ID
	AppIDs CSVStringSlice `url:"app_ids,omitempty"`
	// platform. Possible values: *'ios' — iOS,, *'android' — Android,, *'winphone' — Windows Phone,, *'web' — приложения на vk.com. By default: 'web'.
	Platform      string `url:"platform,omitempty"`
	Extended      bool   `url:"extended,omitempty"`
	ReturnFriends bool   `url:"return_friends,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities', (only if return_friends - 1)
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: 'nom' — nominative (default),, 'gen' — genitive,, 'dat' — dative,, 'acc' — accusative,, 'ins' — instrumental,, 'abl' — prepositional. (only if 'return_friends' = '1')
	NameCase string `url:"name_case,omitempty"`
}

AppsGetParams are params for Apps.Get

type AppsGetResponse

type AppsGetResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

AppsGetResponse is response for Apps.Get

type AppsGetScopesParams

type AppsGetScopesParams struct {
	Type string `url:"type,omitempty"`
}

AppsGetScopesParams are params for Apps.GetScopes

type AppsGetScopesResponse

type AppsGetScopesResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	// Scope description
	Items []struct {
		// Scope name
		Name string `json:"name,omitempty"`
		// Scope title
		Title string `json:"title,omitempty"`
	} `json:"items,omitempty"`
}

AppsGetScopesResponse is response for Apps.GetScopes

type AppsGetScoreParams

type AppsGetScoreParams struct {
	UserID int `url:"user_id"`
}

AppsGetScoreParams are params for Apps.GetScore

type AppsGetScoreResponse

type AppsGetScoreResponse int

AppsGetScoreResponse is response for Apps.GetScore Score number

type AppsSendRequestParams

type AppsSendRequestParams struct {
	// id of the user to send a request
	UserID int `url:"user_id"`
	// request text
	Text string `url:"text,omitempty"`
	// request type. Values: 'invite' – if the request is sent to a user who does not have the app installed,, 'request' – if a user has already installed the app
	Type string `url:"type,omitempty"`
	Name string `url:"name,omitempty"`
	// special string key to be sent with the request
	Key      string `url:"key,omitempty"`
	Separate bool   `url:"separate,omitempty"`
}

AppsSendRequestParams are params for Apps.SendRequest

type AppsSendRequestResponse

type AppsSendRequestResponse int

AppsSendRequestResponse is response for Apps.SendRequest Request ID

type ArrayOnMeth

type ArrayOnMeth []int

ArrayOnMeth is array which is represented as object by VK (see messages.delete)

func (*ArrayOnMeth) UnmarshalEasyJSON

func (v *ArrayOnMeth) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON implements easyjson.Unmarshaler interface

func (*ArrayOnMeth) UnmarshalJSON

func (v *ArrayOnMeth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

type Auth

type Auth struct {
	API vk.API
}

Auth implements VK API namespace `auth`

func (Auth) CheckPhone

func (v Auth) CheckPhone(params AuthCheckPhoneParams) (bool, error)

CheckPhone Checks a user's phone number for correctness.

func (Auth) Restore

func (v Auth) Restore(params AuthRestoreParams) (*AuthRestoreResponse, error)

Restore Allows to restore account access using a code received via SMS. " This method is only available for apps with [vk.com/dev/auth_direct|Direct authorization] access. "

type AuthCheckPhoneParams

type AuthCheckPhoneParams struct {
	// Phone number.
	Phone string `url:"phone"`
	// User ID.
	ClientID     int    `url:"client_id,omitempty"`
	ClientSecret string `url:"client_secret"`
	AuthByPhone  bool   `url:"auth_by_phone,omitempty"`
}

AuthCheckPhoneParams are params for Auth.CheckPhone

type AuthRestoreParams

type AuthRestoreParams struct {
	// User phone number.
	Phone string `url:"phone"`
	// User last name.
	LastName string `url:"last_name"`
}

AuthRestoreParams are params for Auth.Restore

type AuthRestoreResponse

type AuthRestoreResponse struct {
	// 1 if success
	Success int `json:"success,omitempty"`
	// Parameter needed to grant access by code
	Sid string `json:"sid,omitempty"`
}

AuthRestoreResponse is response for Auth.Restore

type Board

type Board struct {
	API vk.API
}

Board implements VK API namespace `board`

func (Board) AddTopic

func (v Board) AddTopic(params BoardAddTopicParams) (BoardAddTopicResponse, error)

AddTopic Creates a new topic on a community's discussion board.

func (Board) CloseTopic

func (v Board) CloseTopic(params BoardCloseTopicParams) (bool, error)

CloseTopic Closes a topic on a community's discussion board so that comments cannot be posted.

func (Board) CreateComment

CreateComment Adds a comment on a topic on a community's discussion board.

func (Board) DeleteComment

func (v Board) DeleteComment(params BoardDeleteCommentParams) (bool, error)

DeleteComment Deletes a comment on a topic on a community's discussion board.

func (Board) DeleteTopic

func (v Board) DeleteTopic(params BoardDeleteTopicParams) (bool, error)

DeleteTopic Deletes a topic from a community's discussion board.

func (Board) EditComment

func (v Board) EditComment(params BoardEditCommentParams) (bool, error)

EditComment Edits a comment on a topic on a community's discussion board.

func (Board) EditTopic

func (v Board) EditTopic(params BoardEditTopicParams) (bool, error)

EditTopic Edits the title of a topic on a community's discussion board.

func (Board) FixTopic

func (v Board) FixTopic(params BoardFixTopicParams) (bool, error)

FixTopic Pins a topic (fixes its place) to the top of a community's discussion board.

func (Board) GetComments

GetComments Returns a list of comments on a topic on a community's discussion board.

func (Board) GetTopics

func (v Board) GetTopics(params BoardGetTopicsParams) (BoardGetTopicsResponse, error)

GetTopics Returns a list of topics on a community's discussion board.

func (Board) OpenTopic

func (v Board) OpenTopic(params BoardOpenTopicParams) (bool, error)

OpenTopic Re-opens a previously closed topic on a community's discussion board.

func (Board) RestoreComment

func (v Board) RestoreComment(params BoardRestoreCommentParams) (bool, error)

RestoreComment Restores a comment deleted from a topic on a community's discussion board.

func (Board) UnfixTopic

func (v Board) UnfixTopic(params BoardUnfixTopicParams) (bool, error)

UnfixTopic Unpins a pinned topic from the top of a community's discussion board.

type BoardAddTopicParams

type BoardAddTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic title.
	Title string `url:"title"`
	// Text of the topic.
	Text string `url:"text,omitempty"`
	// For a community: '1' — to post the topic as by the community, '0' — to post the topic as by the user (default)
	FromGroup bool `url:"from_group,omitempty"`
	// List of media objects attached to the topic, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID. Example: "photo100172_166443618,photo66748_265827614", , "NOTE: If you try to attach more than one reference, an error will be thrown.",
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

BoardAddTopicParams are params for Board.AddTopic

type BoardAddTopicResponse

type BoardAddTopicResponse int

BoardAddTopicResponse is response for Board.AddTopic Topic ID

type BoardCloseTopicParams

type BoardCloseTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
}

BoardCloseTopicParams are params for Board.CloseTopic

type BoardCreateCommentParams

type BoardCreateCommentParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// ID of the topic to be commented on.
	TopicID int `url:"topic_id"`
	// (Required if 'attachments' is not set.) Text of the comment.
	Message string `url:"message,omitempty"`
	// (Required if 'text' is not set.) List of media objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID.
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// '1' — to post the comment as by the community, '0' — to post the comment as by the user (default)
	FromGroup bool `url:"from_group,omitempty"`
	// Sticker ID.
	StickerID int `url:"sticker_id,omitempty"`
	// Unique identifier to avoid repeated comments.
	GUID string `url:"guid,omitempty"`
}

BoardCreateCommentParams are params for Board.CreateComment

type BoardCreateCommentResponse

type BoardCreateCommentResponse int

BoardCreateCommentResponse is response for Board.CreateComment Comment ID

type BoardDeleteCommentParams

type BoardDeleteCommentParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
	// Comment ID.
	CommentID int `url:"comment_id"`
}

BoardDeleteCommentParams are params for Board.DeleteComment

type BoardDeleteTopicParams

type BoardDeleteTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
}

BoardDeleteTopicParams are params for Board.DeleteTopic

type BoardEditCommentParams

type BoardEditCommentParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
	// ID of the comment on the topic.
	CommentID int `url:"comment_id"`
	// (Required if 'attachments' is not set). New comment text.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of media objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID. Example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

BoardEditCommentParams are params for Board.EditComment

type BoardEditTopicParams

type BoardEditTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
	// New title of the topic.
	Title string `url:"title"`
}

BoardEditTopicParams are params for Board.EditTopic

type BoardFixTopicParams

type BoardFixTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
}

BoardFixTopicParams are params for Board.FixTopic

type BoardGetCommentsParams

type BoardGetCommentsParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
	// '1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)
	NeedLikes      bool `url:"need_likes,omitempty"`
	StartCommentID int  `url:"start_comment_id,omitempty"`
	// Offset needed to return a specific subset of comments.
	Offset int `url:"offset,omitempty"`
	// Number of comments to return.
	Count int `url:"count,omitempty"`
	// '1' — to return information about users who posted comments, '0' — to return no additional fields (default)
	Extended bool `url:"extended,omitempty"`
	// Sort order: 'asc' — by creation date in chronological order, 'desc' — by creation date in reverse chronological order,
	Sort string `url:"sort,omitempty"`
}

BoardGetCommentsParams are params for Board.GetComments

type BoardGetCommentsResponse

type BoardGetCommentsResponse interface {
	// contains filtered or unexported methods
}

BoardGetCommentsResponse is response for Board.GetComments Either BoardGetCommentsResponseNormal or BoardGetCommentsResponseExtended, depending on Extended flag

type BoardGetCommentsResponseExtended

type BoardGetCommentsResponseExtended struct {
	// Total number
	Count    int               `json:"count,omitempty"`
	Items    []vk.CommentBoard `json:"items,omitempty"`
	Poll     vk.Poll           `json:"poll,omitempty"`
	Profiles []vk.User         `json:"profiles,omitempty"`
	Groups   []vk.Group        `json:"groups,omitempty"`
}

BoardGetCommentsResponseExtended is extended version of BoardGetCommentsResponse

type BoardGetCommentsResponseNormal

type BoardGetCommentsResponseNormal struct {
	// Total number
	Count int               `json:"count,omitempty"`
	Items []vk.CommentBoard `json:"items,omitempty"`
	Poll  vk.Poll           `json:"poll,omitempty"`
}

BoardGetCommentsResponseNormal is non-extended version of BoardGetCommentsResponse

type BoardGetTopicsParams

type BoardGetTopicsParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// IDs of topics to be returned (100 maximum). By default, all topics are returned. If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.
	TopicIDs CSVIntSlice `url:"topic_ids,omitempty"`
	// Sort order: '1' — by date updated in reverse chronological order. '2' — by date created in reverse chronological order. '-1' — by date updated in chronological order. '-2' — by date created in chronological order. If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.
	Order int `url:"order,omitempty"`
	// Offset needed to return a specific subset of topics.
	Offset int `url:"offset,omitempty"`
	// Number of topics to return.
	Count int `url:"count,omitempty"`
	// '1' — to return information about users who created topics or who posted there last, '0' — to return no additional fields (default)
	Extended bool `url:"extended,omitempty"`
	// '1' — to return the first comment in each topic,, '2' — to return the last comment in each topic,, '0' — to return no comments. By default: '0'.
	Preview int `url:"preview,omitempty"`
	// Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.
	PreviewLength int `url:"preview_length,omitempty"`
}

BoardGetTopicsParams are params for Board.GetTopics

type BoardGetTopicsResponse

type BoardGetTopicsResponse interface {
	// contains filtered or unexported methods
}

BoardGetTopicsResponse is response for Board.GetTopics Either BoardGetTopicsResponseNormal or BoardGetTopicsResponseExtended, depending on Extended flag

type BoardGetTopicsResponseExtended

type BoardGetTopicsResponseExtended struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BoardTopic `json:"items,omitempty"`
	// Sort type
	DefaultOrder int `json:"default_order,omitempty"`
	// Information whether current user can add topic
	CanAddTopics vk.BoolInt `json:"can_add_topics,omitempty"`
	Profiles     []vk.User  `json:"profiles,omitempty"`
}

BoardGetTopicsResponseExtended is extended version of BoardGetTopicsResponse

type BoardGetTopicsResponseNormal

type BoardGetTopicsResponseNormal struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BoardTopic `json:"items,omitempty"`
	// Sort type
	DefaultOrder int `json:"default_order,omitempty"`
	// Information whether current user can add topic
	CanAddTopics vk.BoolInt `json:"can_add_topics,omitempty"`
}

BoardGetTopicsResponseNormal is non-extended version of BoardGetTopicsResponse

type BoardOpenTopicParams

type BoardOpenTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
}

BoardOpenTopicParams are params for Board.OpenTopic

type BoardRestoreCommentParams

type BoardRestoreCommentParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
	// Comment ID.
	CommentID int `url:"comment_id"`
}

BoardRestoreCommentParams are params for Board.RestoreComment

type BoardUnfixTopicParams

type BoardUnfixTopicParams struct {
	// ID of the community that owns the discussion board.
	GroupID int `url:"group_id"`
	// Topic ID.
	TopicID int `url:"topic_id"`
}

BoardUnfixTopicParams are params for Board.UnfixTopic

type CSVIntSlice

type CSVIntSlice []int

CSVIntSlice is an int slice which gets encoded as comma-separated string API methods sometimes accept arrays of ints, which should be encoded as one comma-separated parameter This is helper type which implements query.Encoder

func (CSVIntSlice) EncodeValues

func (csv CSVIntSlice) EncodeValues(key string, v *url.Values) error

EncodeValues conforms to query.Encoder inteface

type CSVStringSlice

type CSVStringSlice []string

CSVStringSlice is a string slice which gets encoded as comma-separated string API methods often accept arrays of strings, which should be encoded as one comma-separated parameter This is helper type which implements query.Encoder

func (CSVStringSlice) EncodeValues

func (csv CSVStringSlice) EncodeValues(key string, v *url.Values) error

EncodeValues conforms to query.Encoder inteface

type Database

type Database struct {
	API vk.API
}

Database implements VK API namespace `database`

func (Database) GetChairs

GetChairs Returns list of chairs on a specified faculty.

func (Database) GetCities

GetCities Returns a list of cities.

func (Database) GetCitiesByID

GetCitiesByID Returns information about cities by their IDs.

func (Database) GetCountries

GetCountries Returns a list of countries.

func (Database) GetCountriesByID

GetCountriesByID Returns information about countries by their IDs.

func (Database) GetFaculties

GetFaculties Returns a list of faculties (i.e., university departments).

func (Database) GetMetroStations

GetMetroStations Get metro stations by city

func (Database) GetMetroStationsByID

GetMetroStationsByID Get metro station by his id

func (Database) GetRegions

GetRegions Returns a list of regions.

func (Database) GetSchoolClasses

GetSchoolClasses Returns a list of school classes specified for the country.

func (Database) GetSchools

GetSchools Returns a list of schools.

func (Database) GetUniversities

GetUniversities Returns a list of higher education institutions.

type DatabaseGetChairsParams

type DatabaseGetChairsParams struct {
	// id of the faculty to get chairs from
	FacultyID int `url:"faculty_id"`
	// offset required to get a certain subset of chairs
	Offset int `url:"offset,omitempty"`
	// amount of chairs to get
	Count int `url:"count,omitempty"`
}

DatabaseGetChairsParams are params for Database.GetChairs

type DatabaseGetChairsResponse

type DatabaseGetChairsResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetChairsResponse is response for Database.GetChairs

type DatabaseGetCitiesByIDParams

type DatabaseGetCitiesByIDParams struct {
	// City IDs.
	CityIDs CSVIntSlice `url:"city_ids,omitempty"`
}

DatabaseGetCitiesByIDParams are params for Database.GetCitiesByID

type DatabaseGetCitiesByIDResponse

type DatabaseGetCitiesByIDResponse []vk.BaseObject

DatabaseGetCitiesByIDResponse is response for Database.GetCitiesByID

type DatabaseGetCitiesParams

type DatabaseGetCitiesParams struct {
	// Country ID.
	CountryID int `url:"country_id"`
	// Region ID.
	RegionID int `url:"region_id,omitempty"`
	// Search query.
	Q string `url:"q,omitempty"`
	// '1' — to return all cities in the country, '0' — to return major cities in the country (default),
	NeedAll bool `url:"need_all,omitempty"`
	// Offset needed to return a specific subset of cities.
	Offset int `url:"offset,omitempty"`
	// Number of cities to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetCitiesParams are params for Database.GetCities

type DatabaseGetCitiesResponse

type DatabaseGetCitiesResponse struct {
	// Total number
	Count int               `json:"count,omitempty"`
	Items []vk.DatabaseCity `json:"items,omitempty"`
}

DatabaseGetCitiesResponse is response for Database.GetCities

type DatabaseGetCountriesByIDParams

type DatabaseGetCountriesByIDParams struct {
	// Country IDs.
	CountryIDs CSVIntSlice `url:"country_ids,omitempty"`
}

DatabaseGetCountriesByIDParams are params for Database.GetCountriesByID

type DatabaseGetCountriesByIDResponse

type DatabaseGetCountriesByIDResponse []vk.BaseObject

DatabaseGetCountriesByIDResponse is response for Database.GetCountriesByID

type DatabaseGetCountriesParams

type DatabaseGetCountriesParams struct {
	// '1' — to return a full list of all countries, '0' — to return a list of countries near the current user's country (default).
	NeedAll bool `url:"need_all,omitempty"`
	// Country codes in [vk.com/dev/country_codes|ISO 3166-1 alpha-2] standard.
	Code string `url:"code,omitempty"`
	// Offset needed to return a specific subset of countries.
	Offset int `url:"offset,omitempty"`
	// Number of countries to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetCountriesParams are params for Database.GetCountries

type DatabaseGetCountriesResponse

type DatabaseGetCountriesResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetCountriesResponse is response for Database.GetCountries

type DatabaseGetFacultiesParams

type DatabaseGetFacultiesParams struct {
	// University ID.
	UniversityID int `url:"university_id"`
	// Offset needed to return a specific subset of faculties.
	Offset int `url:"offset,omitempty"`
	// Number of faculties to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetFacultiesParams are params for Database.GetFaculties

type DatabaseGetFacultiesResponse

type DatabaseGetFacultiesResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetFacultiesResponse is response for Database.GetFaculties

type DatabaseGetMetroStationsByIDParams

type DatabaseGetMetroStationsByIDParams struct {
	StationIDs CSVIntSlice `url:"station_ids,omitempty"`
}

DatabaseGetMetroStationsByIDParams are params for Database.GetMetroStationsByID

type DatabaseGetMetroStationsByIDResponse

type DatabaseGetMetroStationsByIDResponse []struct {
	// City ID
	CityID int `json:"city_id,omitempty"`
	// Hex color code without #
	Color string `json:"color,omitempty"`
	// Station ID
	ID int `json:"id,omitempty"`
	// Station name
	Name string `json:"name,omitempty"`
}

DatabaseGetMetroStationsByIDResponse is response for Database.GetMetroStationsByID

type DatabaseGetMetroStationsParams

type DatabaseGetMetroStationsParams struct {
	CityID   int  `url:"city_id"`
	Offset   int  `url:"offset,omitempty"`
	Count    int  `url:"count,omitempty"`
	Extended bool `url:"extended,omitempty"`
}

DatabaseGetMetroStationsParams are params for Database.GetMetroStations

type DatabaseGetMetroStationsResponse

type DatabaseGetMetroStationsResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// City ID
		CityID int `json:"city_id,omitempty"`
		// Hex color code without #
		Color string `json:"color,omitempty"`
		// Station ID
		ID int `json:"id,omitempty"`
		// Station name
		Name string `json:"name,omitempty"`
	} `json:"items,omitempty"`
}

DatabaseGetMetroStationsResponse is response for Database.GetMetroStations

type DatabaseGetRegionsParams

type DatabaseGetRegionsParams struct {
	// Country ID, received in [vk.com/dev/database.getCountries|database.getCountries] method.
	CountryID int `url:"country_id"`
	// Search query.
	Q string `url:"q,omitempty"`
	// Offset needed to return specific subset of regions.
	Offset int `url:"offset,omitempty"`
	// Number of regions to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetRegionsParams are params for Database.GetRegions

type DatabaseGetRegionsResponse

type DatabaseGetRegionsResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetRegionsResponse is response for Database.GetRegions

type DatabaseGetSchoolClassesParams

type DatabaseGetSchoolClassesParams struct {
	// Country ID.
	CountryID int `url:"country_id,omitempty"`
}

DatabaseGetSchoolClassesParams are params for Database.GetSchoolClasses

type DatabaseGetSchoolClassesResponse

type DatabaseGetSchoolClassesResponse [][]genTODOType

DatabaseGetSchoolClassesResponse is response for Database.GetSchoolClasses Class ID or letter

type DatabaseGetSchoolsParams

type DatabaseGetSchoolsParams struct {
	// Search query.
	Q string `url:"q,omitempty"`
	// City ID.
	CityID int `url:"city_id"`
	// Offset needed to return a specific subset of schools.
	Offset int `url:"offset,omitempty"`
	// Number of schools to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetSchoolsParams are params for Database.GetSchools

type DatabaseGetSchoolsResponse

type DatabaseGetSchoolsResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetSchoolsResponse is response for Database.GetSchools

type DatabaseGetUniversitiesParams

type DatabaseGetUniversitiesParams struct {
	// Search query.
	Q string `url:"q,omitempty"`
	// Country ID.
	CountryID int `url:"country_id,omitempty"`
	// City ID.
	CityID int `url:"city_id,omitempty"`
	// Offset needed to return a specific subset of universities.
	Offset int `url:"offset,omitempty"`
	// Number of universities to return.
	Count int `url:"count,omitempty"`
}

DatabaseGetUniversitiesParams are params for Database.GetUniversities

type DatabaseGetUniversitiesResponse

type DatabaseGetUniversitiesResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.BaseObject `json:"items,omitempty"`
}

DatabaseGetUniversitiesResponse is response for Database.GetUniversities

type Docs

type Docs struct {
	API vk.API
}

Docs implements VK API namespace `docs`

func (Docs) Add

func (v Docs) Add(params DocsAddParams) (*DocsAddResponse, error)

Add Copies a document to a user's or community's document list.

func (Docs) Delete

func (v Docs) Delete(params DocsDeleteParams) (bool, error)

Delete Deletes a user or community document.

func (Docs) Edit

func (v Docs) Edit(params DocsEditParams) (bool, error)

Edit Edits a document.

func (Docs) Get

func (v Docs) Get(params DocsGetParams) (*DocsGetResponse, error)

Get Returns detailed information about user or community documents.

func (Docs) GetByID

func (v Docs) GetByID(params DocsGetByIDParams) (DocsGetByIDResponse, error)

GetByID Returns information about documents by their IDs.

func (Docs) GetMessagesUploadServer

GetMessagesUploadServer Returns the server address for document upload.

func (Docs) GetTypes

func (v Docs) GetTypes(params DocsGetTypesParams) (*DocsGetTypesResponse, error)

GetTypes Returns documents types available for current user.

func (Docs) GetUploadServer

func (v Docs) GetUploadServer(params DocsGetUploadServerParams) (*DocsGetUploadServerResponse, error)

GetUploadServer Returns the server address for document upload.

func (Docs) GetWallUploadServer

func (v Docs) GetWallUploadServer(params DocsGetWallUploadServerParams) (*DocsGetWallUploadServerResponse, error)

GetWallUploadServer Returns the server address for document upload onto a user's or community's wall.

func (Docs) Save

func (v Docs) Save(params DocsSaveParams) (DocsSaveResponse, error)

Save Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].

func (Docs) Search

func (v Docs) Search(params DocsSearchParams) (*DocsSearchResponse, error)

Search Returns a list of documents matching the search criteria.

type DocsAddParams

type DocsAddParams struct {
	// ID of the user or community that owns the document. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
	// Document ID.
	DocID int `url:"doc_id"`
	// Access key. This parameter is required if 'access_key' was returned with the document's data.
	AccessKey string `url:"access_key,omitempty"`
}

DocsAddParams are params for Docs.Add

type DocsAddResponse

type DocsAddResponse struct {
	// Doc ID
	ID int `json:"id,omitempty"`
}

DocsAddResponse is response for Docs.Add

type DocsDeleteParams

type DocsDeleteParams struct {
	// ID of the user or community that owns the document. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
	// Document ID.
	DocID int `url:"doc_id"`
}

DocsDeleteParams are params for Docs.Delete

type DocsEditParams

type DocsEditParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
	// Document ID.
	DocID int `url:"doc_id"`
	// Document title.
	Title string `url:"title,omitempty"`
	// Document tags.
	Tags CSVStringSlice `url:"tags,omitempty"`
}

DocsEditParams are params for Docs.Edit

type DocsGetByIDParams

type DocsGetByIDParams struct {
	// Document IDs. Example: , "66748_91488,66748_91455",
	Docs CSVStringSlice `url:"docs"`
}

DocsGetByIDParams are params for Docs.GetByID

type DocsGetByIDResponse

type DocsGetByIDResponse []vk.Document

DocsGetByIDResponse is response for Docs.GetByID

type DocsGetMessagesUploadServerParams

type DocsGetMessagesUploadServerParams struct {
	// Document type.
	Type string `url:"type,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
}

DocsGetMessagesUploadServerParams are params for Docs.GetMessagesUploadServer

type DocsGetMessagesUploadServerResponse

type DocsGetMessagesUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

DocsGetMessagesUploadServerResponse is response for Docs.GetMessagesUploadServer

type DocsGetParams

type DocsGetParams struct {
	// Number of documents to return. By default, all documents.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of documents.
	Offset int `url:"offset,omitempty"`
	Type   int `url:"type,omitempty"`
	// ID of the user or community that owns the documents. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
}

DocsGetParams are params for Docs.Get

type DocsGetResponse

type DocsGetResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []vk.Document `json:"items,omitempty"`
}

DocsGetResponse is response for Docs.Get

type DocsGetTypesParams

type DocsGetTypesParams struct {
	// ID of the user or community that owns the documents. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
}

DocsGetTypesParams are params for Docs.GetTypes

type DocsGetTypesResponse

type DocsGetTypesResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Doc type ID
		ID int `json:"id,omitempty"`
		// Doc type title
		Title string `json:"title,omitempty"`
		// Number of docs
		Count int `json:"count,omitempty"`
	} `json:"items,omitempty"`
}

DocsGetTypesResponse is response for Docs.GetTypes

type DocsGetUploadServerParams

type DocsGetUploadServerParams struct {
	// Community ID (if the document will be uploaded to the community).
	GroupID int `url:"group_id,omitempty"`
}

DocsGetUploadServerParams are params for Docs.GetUploadServer

type DocsGetUploadServerResponse

type DocsGetUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

DocsGetUploadServerResponse is response for Docs.GetUploadServer

type DocsGetWallUploadServerParams

type DocsGetWallUploadServerParams struct {
	// Community ID (if the document will be uploaded to the community).
	GroupID int `url:"group_id,omitempty"`
}

DocsGetWallUploadServerParams are params for Docs.GetWallUploadServer

type DocsGetWallUploadServerResponse

type DocsGetWallUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

DocsGetWallUploadServerResponse is response for Docs.GetWallUploadServer

type DocsSaveParams

type DocsSaveParams struct {
	// This parameter is returned when the file is [vk.com/dev/upload_files_2|uploaded to the server].
	File string `url:"file"`
	// Document title.
	Title string `url:"title,omitempty"`
	// Document tags.
	Tags string `url:"tags,omitempty"`
}

DocsSaveParams are params for Docs.Save

type DocsSaveResponse

type DocsSaveResponse []vk.Document

DocsSaveResponse is response for Docs.Save

type DocsSearchParams

type DocsSearchParams struct {
	// Search query string.
	Q         string `url:"q"`
	SearchOwn bool   `url:"search_own,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
}

DocsSearchParams are params for Docs.Search

type DocsSearchResponse

type DocsSearchResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []vk.Document `json:"items,omitempty"`
}

DocsSearchResponse is response for Docs.Search

type Fave

type Fave struct {
	API vk.API
}

Fave implements VK API namespace `fave`

func (Fave) AddGroup

func (v Fave) AddGroup(params FaveAddGroupParams) (bool, error)

AddGroup Adds a community to user faves.

func (v Fave) AddLink(params FaveAddLinkParams) (bool, error)

AddLink Adds a link to user faves.

func (Fave) AddUser

func (v Fave) AddUser(params FaveAddUserParams) (bool, error)

AddUser Adds a profile to user faves.

func (v Fave) GetLinks(params FaveGetLinksParams) (*FaveGetLinksResponse, error)

GetLinks Returns a list of links that the current user has bookmarked.

func (Fave) GetMarketItems

func (v Fave) GetMarketItems(params FaveGetMarketItemsParams) (*FaveGetMarketItemsResponse, error)

GetMarketItems Returns market items bookmarked by current user.

func (Fave) GetPhotos

func (v Fave) GetPhotos(params FaveGetPhotosParams) (*FaveGetPhotosResponse, error)

GetPhotos Returns a list of photos that the current user has liked.

func (Fave) GetPosts

func (v Fave) GetPosts(params FaveGetPostsParams) (*FaveGetPostsResponse, error)

GetPosts Returns a list of wall posts that the current user has liked.

func (Fave) GetUsers

func (v Fave) GetUsers(params FaveGetUsersParams) (*FaveGetUsersResponse, error)

GetUsers Returns a list of users whom the current user has bookmarked.

func (Fave) GetVideos

func (v Fave) GetVideos(params FaveGetVideosParams) (*FaveGetVideosResponse, error)

GetVideos Returns a list of videos that the current user has liked.

func (Fave) RemoveGroup

func (v Fave) RemoveGroup(params FaveRemoveGroupParams) (bool, error)

RemoveGroup Removes a community from user faves.

func (v Fave) RemoveLink(params FaveRemoveLinkParams) (bool, error)

RemoveLink Removes link from the user's faves.

func (Fave) RemoveUser

func (v Fave) RemoveUser(params FaveRemoveUserParams) (bool, error)

RemoveUser Removes a profile from user faves.

type FaveAddGroupParams

type FaveAddGroupParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

FaveAddGroupParams are params for Fave.AddGroup

type FaveAddLinkParams

type FaveAddLinkParams struct {
	// Link URL.
	Link string `url:"link"`
}

FaveAddLinkParams are params for Fave.AddLink

type FaveAddUserParams

type FaveAddUserParams struct {
	// Profile ID.
	UserID int `url:"user_id"`
}

FaveAddUserParams are params for Fave.AddUser

type FaveGetLinksParams

type FaveGetLinksParams struct {
	// Offset needed to return a specific subset of users.
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
}

FaveGetLinksParams are params for Fave.GetLinks

type FaveGetLinksResponse

type FaveGetLinksResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []vk.MiniLink `json:"items,omitempty"`
}

FaveGetLinksResponse is response for Fave.GetLinks

type FaveGetMarketItemsParams

type FaveGetMarketItemsParams struct {
	// Number of results to return.
	Count  int `url:"count,omitempty"`
	Offset int `url:"offset,omitempty"`
	// '1' – to return additional fields 'likes, can_comment, can_repost, photos'. By default: '0'.
	Extended bool `url:"extended,omitempty"`
}

FaveGetMarketItemsParams are params for Fave.GetMarketItems

type FaveGetMarketItemsResponse

type FaveGetMarketItemsResponse struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

FaveGetMarketItemsResponse is response for Fave.GetMarketItems

type FaveGetPhotosParams

type FaveGetPhotosParams struct {
	// Offset needed to return a specific subset of photos.
	Offset int `url:"offset,omitempty"`
	// Number of photos to return.
	Count int `url:"count,omitempty"`
}

FaveGetPhotosParams are params for Fave.GetPhotos

type FaveGetPhotosResponse

type FaveGetPhotosResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

FaveGetPhotosResponse is response for Fave.GetPhotos

type FaveGetPostsParams

type FaveGetPostsParams struct {
	// Offset needed to return a specific subset of posts.
	Offset int `url:"offset,omitempty"`
	// Number of posts to return.
	Count int `url:"count,omitempty"`
	// '1' — to return additional 'wall', 'profiles', and 'groups' fields. By default: '0'.
	Extended bool `url:"extended,omitempty"`
}

FaveGetPostsParams are params for Fave.GetPosts

type FaveGetPostsResponse

type FaveGetPostsResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Post `json:"items,omitempty"`
}

FaveGetPostsResponse is response for Fave.GetPosts

type FaveGetUsersParams

type FaveGetUsersParams struct {
	// Offset needed to return a specific subset of users.
	Offset int `url:"offset,omitempty"`
	// Number of users to return.
	Count int `url:"count,omitempty"`
}

FaveGetUsersParams are params for Fave.GetUsers

type FaveGetUsersResponse

type FaveGetUsersResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

FaveGetUsersResponse is response for Fave.GetUsers

type FaveGetVideosParams

type FaveGetVideosParams struct {
	// Offset needed to return a specific subset of videos.
	Offset int `url:"offset,omitempty"`
	// Number of videos to return.
	Count int `url:"count,omitempty"`
	// Return an additional information about videos. Also returns all owners profiles and groups.
	Extended bool `url:"extended,omitempty"`
}

FaveGetVideosParams are params for Fave.GetVideos

type FaveGetVideosResponse

type FaveGetVideosResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Video `json:"items,omitempty"`
}

FaveGetVideosResponse is response for Fave.GetVideos

type FaveRemoveGroupParams

type FaveRemoveGroupParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

FaveRemoveGroupParams are params for Fave.RemoveGroup

type FaveRemoveLinkParams

type FaveRemoveLinkParams struct {
	// Link ID (can be obtained by [vk.com/dev/faves.getLinks|faves.getLinks] method).
	LinkID string `url:"link_id,omitempty"`
}

FaveRemoveLinkParams are params for Fave.RemoveLink

type FaveRemoveUserParams

type FaveRemoveUserParams struct {
	// Profile ID.
	UserID int `url:"user_id"`
}

FaveRemoveUserParams are params for Fave.RemoveUser

type Friends

type Friends struct {
	API vk.API
}

Friends implements VK API namespace `friends`

func (Friends) Add

Add Approves or creates a friend request.

func (Friends) AddList

AddList Creates a new friend list for the current user.

func (Friends) AreFriends

AreFriends Checks the current user's friendship status with other specified users.

func (Friends) Delete

Delete Declines a friend request or deletes a user from the current user's friend list.

func (Friends) DeleteAllRequests

func (v Friends) DeleteAllRequests() (bool, error)

DeleteAllRequests Marks all incoming friend requests as viewed.

func (Friends) DeleteList

func (v Friends) DeleteList(params FriendsDeleteListParams) (bool, error)

DeleteList Deletes a friend list of the current user.

func (Friends) Edit

func (v Friends) Edit(params FriendsEditParams) (bool, error)

Edit Edits the friend lists of the selected user.

func (Friends) EditList

func (v Friends) EditList(params FriendsEditListParams) (bool, error)

EditList Edits a friend list of the current user.

func (Friends) Get

Get Returns a list of user IDs or detailed information about a user's friends.

func (Friends) GetAppUsers

func (v Friends) GetAppUsers() (FriendsGetAppUsersResponse, error)

GetAppUsers Returns a list of IDs of the current user's friends who installed the application.

func (Friends) GetByPhones

GetByPhones Returns a list of the current user's friends whose phone numbers, validated or specified in a profile, are in a given list.

func (Friends) GetLists

GetLists Returns a list of the user's friend lists.

func (Friends) GetMutual

GetMutual Returns a list of user IDs of the mutual friends of two users.

func (Friends) GetOnline

GetOnline Returns a list of user IDs of a user's friends who are online.

func (Friends) GetRecent

GetRecent Returns a list of user IDs of the current user's recently added friends.

func (Friends) GetRequests

GetRequests Returns information about the current user's incoming and outgoing friend requests.

func (Friends) GetSuggestions

GetSuggestions Returns a list of profiles of users whom the current user may know.

func (Friends) Search

Search Returns a list of friends matching the search criteria.

type FriendsAddListParams

type FriendsAddListParams struct {
	// Name of the friend list.
	Name string `url:"name"`
	// IDs of users to be added to the friend list.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
}

FriendsAddListParams are params for Friends.AddList

type FriendsAddListResponse

type FriendsAddListResponse struct {
	// List ID
	ListID int `json:"list_id,omitempty"`
}

FriendsAddListResponse is response for Friends.AddList

type FriendsAddParams

type FriendsAddParams struct {
	// ID of the user whose friend request will be approved or to whom a friend request will be sent.
	UserID int `url:"user_id,omitempty"`
	// Text of the message (up to 500 characters) for the friend request, if any.
	Text string `url:"text,omitempty"`
	// '1' to pass an incoming request to followers list.
	Follow bool `url:"follow,omitempty"`
}

FriendsAddParams are params for Friends.Add

type FriendsAddResponse

type FriendsAddResponse int

FriendsAddResponse is response for Friends.Add Friend request status

type FriendsAreFriendsParams

type FriendsAreFriendsParams struct {
	// IDs of the users whose friendship status to check.
	UserIDs CSVIntSlice `url:"user_ids"`
	// '1' — to return 'sign' field. 'sign' is md5("{id}_{user_id}_{friends_status}_{application_secret}"), where id is current user ID. This field allows to check that data has not been modified by the client. By default: '0'.
	NeedSign bool `url:"need_sign,omitempty"`
}

FriendsAreFriendsParams are params for Friends.AreFriends

type FriendsAreFriendsResponse

type FriendsAreFriendsResponse []struct {
	// User ID
	UserID int `json:"user_id,omitempty"`
	// Friend status with the user
	FriendStatus int `json:"friend_status,omitempty"`
	// Message sent with request
	RequestMessage string `json:"request_message,omitempty"`
	// Information whether request is unviewed
	ReadState vk.BoolInt `json:"read_state,omitempty"`
	// MD5 hash for the result validation
	Sign string `json:"sign,omitempty"`
}

FriendsAreFriendsResponse is response for Friends.AreFriends

type FriendsDeleteListParams

type FriendsDeleteListParams struct {
	// ID of the friend list to delete.
	ListID int `url:"list_id"`
}

FriendsDeleteListParams are params for Friends.DeleteList

type FriendsDeleteParams

type FriendsDeleteParams struct {
	// ID of the user whose friend request is to be declined or who is to be deleted from the current user's friend list.
	UserID int `url:"user_id,omitempty"`
}

FriendsDeleteParams are params for Friends.Delete

type FriendsDeleteResponse

type FriendsDeleteResponse struct {
	Success vk.BoolInt `json:"success,omitempty"`
	// Returns 1 if friend has been deleted
	FriendDeleted int `json:"friend_deleted,omitempty"`
	// Returns 1 if out request has been canceled
	OutRequestDeleted int `json:"out_request_deleted,omitempty"`
	// Returns 1 if incoming request has been declined
	InRequestDeleted int `json:"in_request_deleted,omitempty"`
	// Returns 1 if suggestion has been declined
	SuggestionDeleted int `json:"suggestion_deleted,omitempty"`
}

FriendsDeleteResponse is response for Friends.Delete

type FriendsEditListParams

type FriendsEditListParams struct {
	// Name of the friend list.
	Name string `url:"name,omitempty"`
	// Friend list ID.
	ListID int `url:"list_id"`
	// IDs of users in the friend list.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// (Applies if 'user_ids' parameter is not set.), User IDs to add to the friend list.
	AddUserIDs CSVIntSlice `url:"add_user_ids,omitempty"`
	// (Applies if 'user_ids' parameter is not set.), User IDs to delete from the friend list.
	DeleteUserIDs CSVIntSlice `url:"delete_user_ids,omitempty"`
}

FriendsEditListParams are params for Friends.EditList

type FriendsEditParams

type FriendsEditParams struct {
	// ID of the user whose friend list is to be edited.
	UserID int `url:"user_id"`
	// IDs of the friend lists to which to add the user.
	ListIDs CSVIntSlice `url:"list_ids,omitempty"`
}

FriendsEditParams are params for Friends.Edit

type FriendsGetAppUsersResponse

type FriendsGetAppUsersResponse []int

FriendsGetAppUsersResponse is response for Friends.GetAppUsers User ID

type FriendsGetByPhonesParams

type FriendsGetByPhonesParams struct {
	// List of phone numbers in MSISDN format (maximum 1000). Example: "+79219876543,+79111234567"
	Phones CSVStringSlice `url:"phones,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online, counters'.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

FriendsGetByPhonesParams are params for Friends.GetByPhones

type FriendsGetByPhonesResponse

type FriendsGetByPhonesResponse []vk.User

FriendsGetByPhonesResponse is response for Friends.GetByPhones

type FriendsGetListsParams

type FriendsGetListsParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// '1' — to return system friend lists. By default: '0'.
	ReturnSystem bool `url:"return_system,omitempty"`
}

FriendsGetListsParams are params for Friends.GetLists

type FriendsGetListsResponse

type FriendsGetListsResponse struct {
	// Total communities number
	Count int `json:"count,omitempty"`
	Items []struct {
		// List title
		Name string `json:"name,omitempty"`
		// List ID
		ID int `json:"id,omitempty"`
	} `json:"items,omitempty"`
}

FriendsGetListsResponse is response for Friends.GetLists

type FriendsGetMutualParams

type FriendsGetMutualParams struct {
	// ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.
	SourceUID int `url:"source_uid,omitempty"`
	// ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.
	TargetUID int `url:"target_uid,omitempty"`
	// IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.
	TargetUIDs CSVIntSlice `url:"target_uids,omitempty"`
	// Sort order: 'random' — random order
	Order string `url:"order,omitempty"`
	// Number of mutual friends to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of mutual friends.
	Offset int `url:"offset,omitempty"`
}

FriendsGetMutualParams are params for Friends.GetMutual

type FriendsGetMutualResponse

type FriendsGetMutualResponse []int

FriendsGetMutualResponse is response for Friends.GetMutual User ID

type FriendsGetOnlineParams

type FriendsGetOnlineParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Friend list ID. If this parameter is not set, information about all online friends is returned.
	ListID int `url:"list_id,omitempty"`
	// '1' — to return an additional 'online_mobile' field, '0' — (default),
	OnlineMobile bool `url:"online_mobile,omitempty"`
	// Sort order: 'random' — random order
	Order string `url:"order,omitempty"`
	// Number of friends to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of friends.
	Offset int `url:"offset,omitempty"`
}

FriendsGetOnlineParams are params for Friends.GetOnline

type FriendsGetOnlineResponse

type FriendsGetOnlineResponse []int

FriendsGetOnlineResponse is response for Friends.GetOnline User ID

type FriendsGetParams

type FriendsGetParams struct {
	// User ID. By default, the current user ID.
	UserID int `url:"user_id,omitempty"`
	// Sort order: , 'name' — by name (enabled only if the 'fields' parameter is used), 'hints' — by rating, similar to how friends are sorted in My friends section, , This parameter is available only for [vk.com/dev/standalone|desktop applications].
	Order string `url:"order,omitempty"`
	// ID of the friend list returned by the [vk.com/dev/friends.getLists|friends.getLists] method to be used as the source. This parameter is taken into account only when the uid parameter is set to the current user ID. This parameter is available only for [vk.com/dev/standalone|desktop applications].
	ListID int `url:"list_id,omitempty"`
	// Number of friends to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of friends.
	Offset int `url:"offset,omitempty"`
	// Profile fields to return. Sample values: 'uid', 'first_name', 'last_name', 'nickname', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'domain', 'has_mobile', 'rate', 'contacts', 'education'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

FriendsGetParams are params for Friends.Get

type FriendsGetRecentParams

type FriendsGetRecentParams struct {
	// Number of recently added friends to return.
	Count int `url:"count,omitempty"`
}

FriendsGetRecentParams are params for Friends.GetRecent

type FriendsGetRecentResponse

type FriendsGetRecentResponse []int

FriendsGetRecentResponse is response for Friends.GetRecent User ID

type FriendsGetRequestsParams

type FriendsGetRequestsParams struct {
	// Offset needed to return a specific subset of friend requests.
	Offset int `url:"offset,omitempty"`
	// Number of friend requests to return (default 100, maximum 1000).
	Count int `url:"count,omitempty"`
	// '1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends
	Extended bool `url:"extended,omitempty"`
	// '1' — to return a list of mutual friends (up to 20), if any
	NeedMutual bool `url:"need_mutual,omitempty"`
	// '1' — to return outgoing requests, '0' — to return incoming requests (default)
	Out bool `url:"out,omitempty"`
	// Sort order: '1' — by number of mutual friends, '0' — by date
	Sort       int  `url:"sort,omitempty"`
	NeedViewed bool `url:"need_viewed,omitempty"`
	// '1' — to return a list of suggested friends, '0' — to return friend requests (default)
	Suggested bool `url:"suggested,omitempty"`
}

FriendsGetRequestsParams are params for Friends.GetRequests

type FriendsGetRequestsResponse

type FriendsGetRequestsResponse interface {
	// contains filtered or unexported methods
}

FriendsGetRequestsResponse is response for Friends.GetRequests Either FriendsGetRequestsResponseNormal or FriendsGetRequestsResponseExtended, depending on Extended flag

type FriendsGetRequestsResponseExtended

type FriendsGetRequestsResponseExtended struct {
	// Total requests number
	Count int `json:"count,omitempty"`
	Items []struct {
		// User ID
		UserID int `json:"user_id,omitempty"`
		// ID of the user by whom friend has been suggested
		From   string `json:"from,omitempty"`
		Mutual struct {
			// Total mutual friends number
			Count int `json:"count,omitempty"`
			// User ID
			Users []int `json:"users,omitempty"`
		} `json:"mutual,omitempty"`
		// Message sent with a request
		Message string `json:"message,omitempty"`
	} `json:"items,omitempty"`
}

FriendsGetRequestsResponseExtended is extended version of FriendsGetRequestsResponse

type FriendsGetRequestsResponseNormal

type FriendsGetRequestsResponseNormal struct {
	// Total requests number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
	// Total unread requests number
	CountUnread int `json:"count_unread,omitempty"`
}

FriendsGetRequestsResponseNormal is non-extended version of FriendsGetRequestsResponse

type FriendsGetResponse

type FriendsGetResponse struct {
	// Total friends number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
}

FriendsGetResponse is response for Friends.Get

type FriendsGetSuggestionsParams

type FriendsGetSuggestionsParams struct {
	// Types of potential friends to return: 'mutual' — users with many mutual friends , 'contacts' — users found with the [vk.com/dev/account.importContacts|account.importContacts] method , 'mutual_contacts' — users who imported the same contacts as the current user with the [vk.com/dev/account.importContacts|account.importContacts] method
	Filter CSVStringSlice `url:"filter,omitempty"`
	// Number of suggestions to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of suggestions.
	Offset int `url:"offset,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

FriendsGetSuggestionsParams are params for Friends.GetSuggestions

type FriendsGetSuggestionsResponse

type FriendsGetSuggestionsResponse struct {
	// Total results number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

FriendsGetSuggestionsResponse is response for Friends.GetSuggestions

type FriendsSearchParams

type FriendsSearchParams struct {
	// User ID.
	UserID int `url:"user_id"`
	// Search query string (e.g., 'Vasya Babich').
	Q string `url:"q,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online',
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
	// Offset needed to return a specific subset of friends.
	Offset int `url:"offset,omitempty"`
	// Number of friends to return.
	Count int `url:"count,omitempty"`
}

FriendsSearchParams are params for Friends.Search

type FriendsSearchResponse

type FriendsSearchResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

FriendsSearchResponse is response for Friends.Search

type Gifts

type Gifts struct {
	API vk.API
}

Gifts implements VK API namespace `gifts`

func (Gifts) Get

func (v Gifts) Get(params GiftsGetParams) (*GiftsGetResponse, error)

Get Returns a list of user gifts.

type GiftsGetParams

type GiftsGetParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Number of gifts to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
}

GiftsGetParams are params for Gifts.Get

type GiftsGetResponse

type GiftsGetResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Gift `json:"items,omitempty"`
}

GiftsGetResponse is response for Gifts.Get

type Groups

type Groups struct {
	API vk.API
}

Groups implements VK API namespace `groups`

func (Groups) AddAddress

AddAddress does groups.addAddress

func (v Groups) AddLink(params GroupsAddLinkParams) (*GroupsAddLinkResponse, error)

AddLink Allows to add a link to the community.

func (Groups) ApproveRequest

func (v Groups) ApproveRequest(params GroupsApproveRequestParams) (bool, error)

ApproveRequest Allows to approve join request to the community.

func (Groups) Ban

func (v Groups) Ban(params GroupsBanParams) (bool, error)

Ban does groups.ban

func (Groups) Create

func (v Groups) Create(params GroupsCreateParams) (*GroupsCreateResponse, error)

Create Creates a new community.

func (Groups) DeleteCallbackServer

func (v Groups) DeleteCallbackServer(params GroupsDeleteCallbackServerParams) (bool, error)

DeleteCallbackServer does groups.deleteCallbackServer

func (v Groups) DeleteLink(params GroupsDeleteLinkParams) (bool, error)

DeleteLink Allows to delete a link from the community.

func (Groups) DisableOnline

func (v Groups) DisableOnline(params GroupsDisableOnlineParams) (bool, error)

DisableOnline does groups.disableOnline

func (Groups) Edit

func (v Groups) Edit(params GroupsEditParams) (bool, error)

Edit Edits a community.

func (Groups) EditAddress

EditAddress does groups.editAddress

func (Groups) EditCallbackServer

func (v Groups) EditCallbackServer(params GroupsEditCallbackServerParams) (bool, error)

EditCallbackServer does groups.editCallbackServer

func (v Groups) EditLink(params GroupsEditLinkParams) (bool, error)

EditLink Allows to edit a link in the community.

func (Groups) EditManager

func (v Groups) EditManager(params GroupsEditManagerParams) (bool, error)

EditManager Allows to add, remove or edit the community manager.

func (Groups) EnableOnline

func (v Groups) EnableOnline(params GroupsEnableOnlineParams) (bool, error)

EnableOnline does groups.enableOnline

func (Groups) Get

func (v Groups) Get(params GroupsGetParams) (GroupsGetResponse, error)

Get Returns a list of the communities to which a user belongs.

func (Groups) GetAddresses

GetAddresses Returns a list of community addresses.

func (Groups) GetBanned

GetBanned Returns a list of users on a community blacklist.

func (Groups) GetByID

GetByID Returns information about communities by their IDs.

func (Groups) GetCallbackConfirmationCode

GetCallbackConfirmationCode Returns Callback API confirmation code for the community.

func (Groups) GetCallbackSettings

GetCallbackSettings Returns [vk.com/dev/callback_api|Callback API] notifications settings.

func (Groups) GetCatalog

GetCatalog Returns communities list for a catalog category.

func (Groups) GetCatalogInfo

GetCatalogInfo Returns categories list for communities catalog

func (Groups) GetInvitedUsers

GetInvitedUsers Returns invited users list of a community

func (Groups) GetInvites

GetInvites Returns a list of invitations to join communities and events.

func (Groups) GetLongPollServer

GetLongPollServer Returns the data needed to query a Long Poll server for events

func (Groups) GetLongPollSettings

GetLongPollSettings Returns Long Poll notification settings

func (Groups) GetMembers

GetMembers Returns a list of community members.

func (Groups) GetRequests

GetRequests Returns a list of requests to the community.

func (Groups) GetSettings

GetSettings Returns community settings.

func (Groups) Invite

func (v Groups) Invite(params GroupsInviteParams) (bool, error)

Invite Allows to invite friends to the community.

func (Groups) IsMember

IsMember Returns information specifying whether a user is a member of a community.

func (Groups) Join

func (v Groups) Join(params GroupsJoinParams) (bool, error)

Join With this method you can join the group or public page, and also confirm your participation in an event.

func (Groups) Leave

func (v Groups) Leave(params GroupsLeaveParams) (bool, error)

Leave With this method you can leave a group, public page, or event.

func (Groups) RemoveUser

func (v Groups) RemoveUser(params GroupsRemoveUserParams) (bool, error)

RemoveUser Removes a user from the community.

func (v Groups) ReorderLink(params GroupsReorderLinkParams) (bool, error)

ReorderLink Allows to reorder links in the community.

func (Groups) Search

func (v Groups) Search(params GroupsSearchParams) (*GroupsSearchResponse, error)

Search Returns a list of communities matching the search criteria.

func (Groups) SetCallbackSettings

func (v Groups) SetCallbackSettings(params GroupsSetCallbackSettingsParams) (bool, error)

SetCallbackSettings Allow to set notifications settings for group.

func (Groups) SetLongPollSettings

func (v Groups) SetLongPollSettings(params GroupsSetLongPollSettingsParams) (bool, error)

SetLongPollSettings Sets Long Poll notification settings

func (Groups) Unban

func (v Groups) Unban(params GroupsUnbanParams) (bool, error)

Unban does groups.unban

type GroupsAddAddressParams

type GroupsAddAddressParams struct {
	GroupID           int     `url:"group_id"`
	Title             string  `url:"title"`
	Address           string  `url:"address"`
	AdditionalAddress string  `url:"additional_address,omitempty"`
	CountryID         int     `url:"country_id"`
	CityID            int     `url:"city_id"`
	MetroID           int     `url:"metro_id,omitempty"`
	Latitude          float32 `url:"latitude"`
	Longitude         float32 `url:"longitude"`
	Phone             string  `url:"phone,omitempty"`
	WorkInfoStatus    string  `url:"work_info_status,omitempty"`
	Timetable         string  `url:"timetable,omitempty"`
	IsMainAddress     bool    `url:"is_main_address,omitempty"`
}

GroupsAddAddressParams are params for Groups.AddAddress

type GroupsAddAddressResponse

type GroupsAddAddressResponse vk.GroupAddress

GroupsAddAddressResponse is response for Groups.AddAddress

type GroupsAddLinkParams

type GroupsAddLinkParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Link URL.
	Link string `url:"link"`
	// Description text for the link.
	Text string `url:"text,omitempty"`
}

GroupsAddLinkParams are params for Groups.AddLink

type GroupsAddLinkResponse

type GroupsAddLinkResponse struct {
	// Link ID
	ID int `json:"id,omitempty"`
	// Link URL
	URL string `json:"url,omitempty"`
	// Information whether the title can be edited
	EditTitle vk.BoolInt `json:"edit_title,omitempty"`
	// Link description
	Desc string `json:"desc,omitempty"`
	// Information whether the image on processing
	ImageProcessing vk.BoolInt `json:"image_processing,omitempty"`
}

GroupsAddLinkResponse is response for Groups.AddLink

type GroupsApproveRequestParams

type GroupsApproveRequestParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// User ID.
	UserID int `url:"user_id"`
}

GroupsApproveRequestParams are params for Groups.ApproveRequest

type GroupsBanParams

type GroupsBanParams struct {
	GroupID        int    `url:"group_id"`
	OwnerID        int    `url:"owner_id,omitempty"`
	EndDate        int    `url:"end_date,omitempty"`
	Reason         int    `url:"reason,omitempty"`
	Comment        string `url:"comment,omitempty"`
	CommentVisible bool   `url:"comment_visible,omitempty"`
}

GroupsBanParams are params for Groups.Ban

type GroupsCreateParams

type GroupsCreateParams struct {
	// Community title.
	Title string `url:"title"`
	// Community description (ignored for 'type' = 'public').
	Description string `url:"description,omitempty"`
	// Community type. Possible values: *'group' – group,, *'event' – event,, *'public' – public page
	Type string `url:"type,omitempty"`
	// Category ID (for 'type' = 'public' only).
	PublicCategory int `url:"public_category,omitempty"`
	// Public page subtype. Possible values: *'1' – place or small business,, *'2' – company, organization or website,, *'3' – famous person or group of people,, *'4' – product or work of art.
	Subtype int `url:"subtype,omitempty"`
}

GroupsCreateParams are params for Groups.Create

type GroupsCreateResponse

type GroupsCreateResponse vk.Group

GroupsCreateResponse is response for Groups.Create

type GroupsDeleteCallbackServerParams

type GroupsDeleteCallbackServerParams struct {
	GroupID  int `url:"group_id"`
	ServerID int `url:"server_id"`
}

GroupsDeleteCallbackServerParams are params for Groups.DeleteCallbackServer

type GroupsDeleteLinkParams

type GroupsDeleteLinkParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Link ID.
	LinkID int `url:"link_id"`
}

GroupsDeleteLinkParams are params for Groups.DeleteLink

type GroupsDisableOnlineParams

type GroupsDisableOnlineParams struct {
	GroupID int `url:"group_id"`
}

GroupsDisableOnlineParams are params for Groups.DisableOnline

type GroupsEditAddressParams

type GroupsEditAddressParams struct {
	GroupID           int     `url:"group_id"`
	AddressID         int     `url:"address_id"`
	Title             string  `url:"title,omitempty"`
	Address           string  `url:"address,omitempty"`
	AdditionalAddress string  `url:"additional_address,omitempty"`
	CountryID         int     `url:"country_id,omitempty"`
	CityID            int     `url:"city_id,omitempty"`
	MetroID           int     `url:"metro_id,omitempty"`
	Latitude          float32 `url:"latitude,omitempty"`
	Longitude         float32 `url:"longitude,omitempty"`
	Phone             string  `url:"phone,omitempty"`
	WorkInfoStatus    string  `url:"work_info_status,omitempty"`
	Timetable         string  `url:"timetable,omitempty"`
	IsMainAddress     bool    `url:"is_main_address,omitempty"`
}

GroupsEditAddressParams are params for Groups.EditAddress

type GroupsEditAddressResponse

type GroupsEditAddressResponse vk.GroupAddress

GroupsEditAddressResponse is response for Groups.EditAddress Result

type GroupsEditCallbackServerParams

type GroupsEditCallbackServerParams struct {
	GroupID   int    `url:"group_id"`
	ServerID  int    `url:"server_id"`
	URL       string `url:"url"`
	Title     string `url:"title"`
	SecretKey string `url:"secret_key,omitempty"`
}

GroupsEditCallbackServerParams are params for Groups.EditCallbackServer

type GroupsEditLinkParams

type GroupsEditLinkParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Link ID.
	LinkID int `url:"link_id"`
	// New description text for the link.
	Text string `url:"text,omitempty"`
}

GroupsEditLinkParams are params for Groups.EditLink

type GroupsEditManagerParams

type GroupsEditManagerParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// User ID.
	UserID int `url:"user_id"`
	// Manager role. Possible values: *'moderator',, *'editor',, *'administrator'.
	Role string `url:"role,omitempty"`
	// '1' — to show the manager in Contacts block of the community.
	IsContact bool `url:"is_contact,omitempty"`
	// Position to show in Contacts block.
	ContactPosition string `url:"contact_position,omitempty"`
	// Contact phone.
	ContactPhone string `url:"contact_phone,omitempty"`
	// Contact e-mail.
	ContactEmail string `url:"contact_email,omitempty"`
}

GroupsEditManagerParams are params for Groups.EditManager

type GroupsEditParams

type GroupsEditParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Community title.
	Title string `url:"title,omitempty"`
	// Community description.
	Description string `url:"description,omitempty"`
	// Community screen name.
	ScreenName string `url:"screen_name,omitempty"`
	// Community type. Possible values: *'0' – open,, *'1' – closed,, *'2' – private.
	Access int `url:"access,omitempty"`
	// Website that will be displayed in the community information field.
	Website string `url:"website,omitempty"`
	// Community subject. Possible values: , *'1' – auto/moto,, *'2' – activity holidays,, *'3' – business,, *'4' – pets,, *'5' – health,, *'6' – dating and communication, , *'7' – games,, *'8' – IT (computers and software),, *'9' – cinema,, *'10' – beauty and fashion,, *'11' – cooking,, *'12' – art and culture,, *'13' – literature,, *'14' – mobile services and internet,, *'15' – music,, *'16' – science and technology,, *'17' – real estate,, *'18' – news and media,, *'19' – security,, *'20' – education,, *'21' – home and renovations,, *'22' – politics,, *'23' – food,, *'24' – industry,, *'25' – travel,, *'26' – work,, *'27' – entertainment,, *'28' – religion,, *'29' – family,, *'30' – sports,, *'31' – insurance,, *'32' – television,, *'33' – goods and services,, *'34' – hobbies,, *'35' – finance,, *'36' – photo,, *'37' – esoterics,, *'38' – electronics and appliances,, *'39' – erotic,, *'40' – humor,, *'41' – society, humanities,, *'42' – design and graphics.
	Subject string `url:"subject,omitempty"`
	// Organizer email (for events).
	Email string `url:"email,omitempty"`
	// Organizer phone number (for events).
	Phone string `url:"phone,omitempty"`
	// RSS feed address for import (available only to communities with special permission. Contact vk.com/support to get it.
	Rss string `url:"rss,omitempty"`
	// Event start date in Unixtime format.
	EventStartDate int `url:"event_start_date,omitempty"`
	// Event finish date in Unixtime format.
	EventFinishDate int `url:"event_finish_date,omitempty"`
	// Organizer community ID (for events only).
	EventGroupID int `url:"event_group_id,omitempty"`
	// Public page category ID.
	PublicCategory int `url:"public_category,omitempty"`
	// Public page subcategory ID.
	PublicSubcategory int `url:"public_subcategory,omitempty"`
	// Founding date of a company or organization owning the community in "dd.mm.YYYY" format.
	PublicDate string `url:"public_date,omitempty"`
	// Wall settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (groups and events only),, *'3' – closed (groups and events only).
	Wall int `url:"wall,omitempty"`
	// Board topics settings. Possbile values: , *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Topics int `url:"topics,omitempty"`
	// Photos settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Photos int `url:"photos,omitempty"`
	// Video settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Video int `url:"video,omitempty"`
	// Audio settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Audio int `url:"audio,omitempty"`
	// Links settings (for public pages only). Possible values: *'0' – disabled,, *'1' – enabled.
	Links bool `url:"links,omitempty"`
	// Events settings (for public pages only). Possible values: *'0' – disabled,, *'1' – enabled.
	Events bool `url:"events,omitempty"`
	// Places settings (for public pages only). Possible values: *'0' – disabled,, *'1' – enabled.
	Places bool `url:"places,omitempty"`
	// Contacts settings (for public pages only). Possible values: *'0' – disabled,, *'1' – enabled.
	Contacts bool `url:"contacts,omitempty"`
	// Documents settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Docs int `url:"docs,omitempty"`
	// Wiki pages settings. Possible values: *'0' – disabled,, *'1' – open,, *'2' – limited (for groups and events only).
	Wiki int `url:"wiki,omitempty"`
	// Community messages. Possible values: *'0' — disabled,, *'1' — enabled.
	Messages  bool `url:"messages,omitempty"`
	Articles  bool `url:"articles,omitempty"`
	Addresses bool `url:"addresses,omitempty"`
	// Community age limits. Possible values: *'1' — no limits,, *'2' — 16+,, *'3' — 18+.
	AgeLimits int `url:"age_limits,omitempty"`
	// Market settings. Possible values: *'0' – disabled,, *'1' – enabled.
	Market bool `url:"market,omitempty"`
	// market comments settings. Possible values: *'0' – disabled,, *'1' – enabled.
	MarketComments bool `url:"market_comments,omitempty"`
	// Market delivery countries.
	MarketCountry CSVIntSlice `url:"market_country,omitempty"`
	// Market delivery cities (if only one country is specified).
	MarketCity CSVIntSlice `url:"market_city,omitempty"`
	// Market currency settings. Possbile values: , *'643' – Russian rubles,, *'980' – Ukrainian hryvnia,, *'398' – Kazakh tenge,, *'978' – Euro,, *'840' – US dollars
	MarketCurrency int `url:"market_currency,omitempty"`
	// Seller contact for market. Set '0' for community messages.
	MarketContact int `url:"market_contact,omitempty"`
	// ID of a wiki page with market description.
	MarketWiki int `url:"market_wiki,omitempty"`
	// Obscene expressions filter in comments. Possible values: , *'0' – disabled,, *'1' – enabled.
	ObsceneFilter bool `url:"obscene_filter,omitempty"`
	// Stopwords filter in comments. Possible values: , *'0' – disabled,, *'1' – enabled.
	ObsceneStopwords bool `url:"obscene_stopwords,omitempty"`
	// Keywords for stopwords filter.
	ObsceneWords     CSVStringSlice `url:"obscene_words,omitempty"`
	MainSection      int            `url:"main_section,omitempty"`
	SecondarySection int            `url:"secondary_section,omitempty"`
	// Country of the community.
	Country int `url:"country,omitempty"`
	// City of the community.
	City int `url:"city,omitempty"`
}

GroupsEditParams are params for Groups.Edit

type GroupsEnableOnlineParams

type GroupsEnableOnlineParams struct {
	GroupID int `url:"group_id"`
}

GroupsEnableOnlineParams are params for Groups.EnableOnline

type GroupsGetAddressesParams

type GroupsGetAddressesParams struct {
	// ID or screen name of the community.
	GroupID    int         `url:"group_id"`
	AddressIDs CSVIntSlice `url:"address_ids,omitempty"`
	// Latitude of  the user geo position.
	Latitude float32 `url:"latitude,omitempty"`
	// Longitude of the user geo position.
	Longitude float32 `url:"longitude,omitempty"`
	// Offset needed to return a specific subset of community addresses.
	Offset int `url:"offset,omitempty"`
	// Number of community addresses to return.
	Count int `url:"count,omitempty"`
	// Address fields
	Fields CSVStringSlice `url:"fields,omitempty"`
}

GroupsGetAddressesParams are params for Groups.GetAddresses

type GroupsGetAddressesResponse

type GroupsGetAddressesResponse struct {
	// Total count of addresses
	Count int               `json:"count,omitempty"`
	Items []vk.GroupAddress `json:"items,omitempty"`
}

GroupsGetAddressesResponse is response for Groups.GetAddresses

type GroupsGetBannedParams

type GroupsGetBannedParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Offset needed to return a specific subset of users.
	Offset int `url:"offset,omitempty"`
	// Number of users to return.
	Count   int            `url:"count,omitempty"`
	Fields  CSVStringSlice `url:"fields,omitempty"`
	OwnerID int            `url:"owner_id,omitempty"`
}

GroupsGetBannedParams are params for Groups.GetBanned

type GroupsGetBannedResponse

type GroupsGetBannedResponse struct {
	// Total users number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Owner type
		Type string `json:"type,omitempty"`
		// Information about group if type = group
		Group vk.Group `json:"group,omitempty"`
		// Information about group if type = profile
		Profile vk.User `json:"profile,omitempty"`
		BanInfo struct {
			// Administrator ID
			AdminID int `json:"admin_id,omitempty"`
			// Date when user has been added to blacklist in Unixtime
			Date int `json:"date,omitempty"`
			// Ban reason
			Reason int `json:"reason,omitempty"`
			// Comment for a ban
			Comment string `json:"comment,omitempty"`
			// Date when user will be removed from blacklist in Unixtime
			EndDate int `json:"end_date,omitempty"`
		} `json:"ban_info,omitempty"`
	} `json:"items,omitempty"`
}

GroupsGetBannedResponse is response for Groups.GetBanned

type GroupsGetByIDParams

type GroupsGetByIDParams struct {
	// IDs or screen names of communities.
	GroupIDs CSVStringSlice `url:"group_ids,omitempty"`
	// ID or screen name of the community.
	GroupID string `url:"group_id,omitempty"`
	// Group fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

GroupsGetByIDParams are params for Groups.GetByID

type GroupsGetByIDResponse

type GroupsGetByIDResponse []vk.Group

GroupsGetByIDResponse is response for Groups.GetByID

type GroupsGetCallbackConfirmationCodeParams

type GroupsGetCallbackConfirmationCodeParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

GroupsGetCallbackConfirmationCodeParams are params for Groups.GetCallbackConfirmationCode

type GroupsGetCallbackConfirmationCodeResponse

type GroupsGetCallbackConfirmationCodeResponse struct {
	// Confirmation code
	Code string `json:"code,omitempty"`
}

GroupsGetCallbackConfirmationCodeResponse is response for Groups.GetCallbackConfirmationCode

type GroupsGetCallbackSettingsParams

type GroupsGetCallbackSettingsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Server ID.
	ServerID int `url:"server_id,omitempty"`
}

GroupsGetCallbackSettingsParams are params for Groups.GetCallbackSettings

type GroupsGetCallbackSettingsResponse

type GroupsGetCallbackSettingsResponse struct {
	// API version used for the events
	APIVersion string `json:"api_version,omitempty"`
	Events     struct {
		MessageNew           vk.BoolInt `json:"message_new,omitempty"`
		MessageReply         vk.BoolInt `json:"message_reply,omitempty"`
		PhotoNew             vk.BoolInt `json:"photo_new,omitempty"`
		AudioNew             vk.BoolInt `json:"audio_new,omitempty"`
		VideoNew             vk.BoolInt `json:"video_new,omitempty"`
		WallReplyNew         vk.BoolInt `json:"wall_reply_new,omitempty"`
		WallReplyEdit        vk.BoolInt `json:"wall_reply_edit,omitempty"`
		WallReplyDelete      vk.BoolInt `json:"wall_reply_delete,omitempty"`
		WallReplyRestore     vk.BoolInt `json:"wall_reply_restore,omitempty"`
		WallPostNew          vk.BoolInt `json:"wall_post_new,omitempty"`
		BoardPostNew         vk.BoolInt `json:"board_post_new,omitempty"`
		BoardPostEdit        vk.BoolInt `json:"board_post_edit,omitempty"`
		BoardPostRestore     vk.BoolInt `json:"board_post_restore,omitempty"`
		BoardPostDelete      vk.BoolInt `json:"board_post_delete,omitempty"`
		PhotoCommentNew      vk.BoolInt `json:"photo_comment_new,omitempty"`
		PhotoCommentEdit     vk.BoolInt `json:"photo_comment_edit,omitempty"`
		PhotoCommentDelete   vk.BoolInt `json:"photo_comment_delete,omitempty"`
		PhotoCommentRestore  vk.BoolInt `json:"photo_comment_restore,omitempty"`
		VideoCommentNew      vk.BoolInt `json:"video_comment_new,omitempty"`
		VideoCommentEdit     vk.BoolInt `json:"video_comment_edit,omitempty"`
		VideoCommentDelete   vk.BoolInt `json:"video_comment_delete,omitempty"`
		VideoCommentRestore  vk.BoolInt `json:"video_comment_restore,omitempty"`
		MarketCommentNew     vk.BoolInt `json:"market_comment_new,omitempty"`
		MarketCommentEdit    vk.BoolInt `json:"market_comment_edit,omitempty"`
		MarketCommentDelete  vk.BoolInt `json:"market_comment_delete,omitempty"`
		MarketCommentRestore vk.BoolInt `json:"market_comment_restore,omitempty"`
		PollVoteNew          vk.BoolInt `json:"poll_vote_new,omitempty"`
		GroupJoin            vk.BoolInt `json:"group_join,omitempty"`
		GroupLeave           vk.BoolInt `json:"group_leave,omitempty"`
		GroupChangeSettings  vk.BoolInt `json:"group_change_settings,omitempty"`
		GroupChangePhoto     vk.BoolInt `json:"group_change_photo,omitempty"`
		GroupOfficersEdit    vk.BoolInt `json:"group_officers_edit,omitempty"`
		MessageAllow         vk.BoolInt `json:"message_allow,omitempty"`
		MessageDeny          vk.BoolInt `json:"message_deny,omitempty"`
		WallRepost           vk.BoolInt `json:"wall_repost,omitempty"`
		UserBlock            vk.BoolInt `json:"user_block,omitempty"`
		UserUnblock          vk.BoolInt `json:"user_unblock,omitempty"`
		MessagesEdit         vk.BoolInt `json:"messages_edit,omitempty"`
		MessageTypingState   vk.BoolInt `json:"message_typing_state,omitempty"`
		LeadFormsNew         vk.BoolInt `json:"lead_forms_new,omitempty"`
	} `json:"events,omitempty"`
}

GroupsGetCallbackSettingsResponse is response for Groups.GetCallbackSettings

type GroupsGetCatalogInfoParams

type GroupsGetCatalogInfoParams struct {
	// 1 – to return communities count and three communities for preview. By default: 0.
	Extended bool `url:"extended,omitempty"`
	// 1 – to return subcategories info. By default: 0.
	Subcategories bool `url:"subcategories,omitempty"`
}

GroupsGetCatalogInfoParams are params for Groups.GetCatalogInfo

type GroupsGetCatalogInfoResponse

type GroupsGetCatalogInfoResponse interface {
	// contains filtered or unexported methods
}

GroupsGetCatalogInfoResponse is response for Groups.GetCatalogInfo Either GroupsGetCatalogInfoResponseNormal or GroupsGetCatalogInfoResponseExtended, depending on Extended flag

type GroupsGetCatalogInfoResponseExtended

type GroupsGetCatalogInfoResponseExtended struct {
	// Information whether catalog is enabled for current user
	Enabled    int           `json:"enabled,omitempty"`
	Categories []vk.Category `json:"categories,omitempty"`
}

GroupsGetCatalogInfoResponseExtended is extended version of GroupsGetCatalogInfoResponse

type GroupsGetCatalogInfoResponseNormal

type GroupsGetCatalogInfoResponseNormal struct {
	// Information whether catalog is enabled for current user
	Enabled    int           `json:"enabled,omitempty"`
	Categories []vk.Category `json:"categories,omitempty"`
}

GroupsGetCatalogInfoResponseNormal is non-extended version of GroupsGetCatalogInfoResponse

type GroupsGetCatalogParams

type GroupsGetCatalogParams struct {
	// Category id received from [vk.com/dev/groups.getCatalogInfo|groups.getCatalogInfo].
	CategoryID int `url:"category_id,omitempty"`
	// Subcategory id received from [vk.com/dev/groups.getCatalogInfo|groups.getCatalogInfo].
	SubcategoryID int `url:"subcategory_id,omitempty"`
}

GroupsGetCatalogParams are params for Groups.GetCatalog

type GroupsGetCatalogResponse

type GroupsGetCatalogResponse struct {
	// Total communities number
	Count int        `json:"count,omitempty"`
	Items []vk.Group `json:"items,omitempty"`
}

GroupsGetCatalogResponse is response for Groups.GetCatalog

type GroupsGetInvitedUsersParams

type GroupsGetInvitedUsersParams struct {
	// Group ID to return invited users for.
	GroupID int `url:"group_id"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// List of additional fields to be returned. Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname. Possible values: *'nom' — nominative (default),, *'gen' — genitive,, *'dat' — dative,, *'acc' — accusative, , *'ins' — instrumental,, *'abl' — prepositional.
	NameCase string `url:"name_case,omitempty"`
}

GroupsGetInvitedUsersParams are params for Groups.GetInvitedUsers

type GroupsGetInvitedUsersResponse

type GroupsGetInvitedUsersResponse struct {
	// Total communities number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

GroupsGetInvitedUsersResponse is response for Groups.GetInvitedUsers

type GroupsGetInvitesParams

type GroupsGetInvitesParams struct {
	// Offset needed to return a specific subset of invitations.
	Offset int `url:"offset,omitempty"`
	// Number of invitations to return.
	Count int `url:"count,omitempty"`
	// '1' — to return additional [vk.com/dev/fields_groups|fields] for communities..
	Extended bool `url:"extended,omitempty"`
}

GroupsGetInvitesParams are params for Groups.GetInvites

type GroupsGetInvitesResponse

type GroupsGetInvitesResponse interface {
	// contains filtered or unexported methods
}

GroupsGetInvitesResponse is response for Groups.GetInvites Either GroupsGetInvitesResponseNormal or GroupsGetInvitesResponseExtended, depending on Extended flag

type GroupsGetInvitesResponseExtended

type GroupsGetInvitesResponseExtended struct {
	// Total communities number
	Count    int        `json:"count,omitempty"`
	Items    []vk.Group `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
}

GroupsGetInvitesResponseExtended is extended version of GroupsGetInvitesResponse

type GroupsGetInvitesResponseNormal

type GroupsGetInvitesResponseNormal struct {
	// Total communities number
	Count int        `json:"count,omitempty"`
	Items []vk.Group `json:"items,omitempty"`
}

GroupsGetInvitesResponseNormal is non-extended version of GroupsGetInvitesResponse

type GroupsGetLongPollServerParams

type GroupsGetLongPollServerParams struct {
	// Community ID
	GroupID int `url:"group_id"`
}

GroupsGetLongPollServerParams are params for Groups.GetLongPollServer

type GroupsGetLongPollServerResponse

type GroupsGetLongPollServerResponse struct {
	// Long Poll key
	Key string `json:"key,omitempty"`
	// Long Poll server address
	Server string `json:"server,omitempty"`
	// Number of the last event
	TS string `json:"ts,omitempty"`
}

GroupsGetLongPollServerResponse is response for Groups.GetLongPollServer

type GroupsGetLongPollSettingsParams

type GroupsGetLongPollSettingsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

GroupsGetLongPollSettingsParams are params for Groups.GetLongPollSettings

type GroupsGetLongPollSettingsResponse

type GroupsGetLongPollSettingsResponse struct {
	// Shows whether Long Poll is enabled
	IsEnabled bool `json:"is_enabled,omitempty"`
	// API version used for the events
	APIVersion string `json:"api_version,omitempty"`
	Events     struct {
		MessageNew           vk.BoolInt `json:"message_new,omitempty"`
		MessageReply         vk.BoolInt `json:"message_reply,omitempty"`
		PhotoNew             vk.BoolInt `json:"photo_new,omitempty"`
		AudioNew             vk.BoolInt `json:"audio_new,omitempty"`
		VideoNew             vk.BoolInt `json:"video_new,omitempty"`
		WallReplyNew         vk.BoolInt `json:"wall_reply_new,omitempty"`
		WallReplyEdit        vk.BoolInt `json:"wall_reply_edit,omitempty"`
		WallReplyDelete      vk.BoolInt `json:"wall_reply_delete,omitempty"`
		WallReplyRestore     vk.BoolInt `json:"wall_reply_restore,omitempty"`
		WallPostNew          vk.BoolInt `json:"wall_post_new,omitempty"`
		BoardPostNew         vk.BoolInt `json:"board_post_new,omitempty"`
		BoardPostEdit        vk.BoolInt `json:"board_post_edit,omitempty"`
		BoardPostRestore     vk.BoolInt `json:"board_post_restore,omitempty"`
		BoardPostDelete      vk.BoolInt `json:"board_post_delete,omitempty"`
		PhotoCommentNew      vk.BoolInt `json:"photo_comment_new,omitempty"`
		PhotoCommentEdit     vk.BoolInt `json:"photo_comment_edit,omitempty"`
		PhotoCommentDelete   vk.BoolInt `json:"photo_comment_delete,omitempty"`
		PhotoCommentRestore  vk.BoolInt `json:"photo_comment_restore,omitempty"`
		VideoCommentNew      vk.BoolInt `json:"video_comment_new,omitempty"`
		VideoCommentEdit     vk.BoolInt `json:"video_comment_edit,omitempty"`
		VideoCommentDelete   vk.BoolInt `json:"video_comment_delete,omitempty"`
		VideoCommentRestore  vk.BoolInt `json:"video_comment_restore,omitempty"`
		MarketCommentNew     vk.BoolInt `json:"market_comment_new,omitempty"`
		MarketCommentEdit    vk.BoolInt `json:"market_comment_edit,omitempty"`
		MarketCommentDelete  vk.BoolInt `json:"market_comment_delete,omitempty"`
		MarketCommentRestore vk.BoolInt `json:"market_comment_restore,omitempty"`
		PollVoteNew          vk.BoolInt `json:"poll_vote_new,omitempty"`
		GroupJoin            vk.BoolInt `json:"group_join,omitempty"`
		GroupLeave           vk.BoolInt `json:"group_leave,omitempty"`
		GroupChangeSettings  vk.BoolInt `json:"group_change_settings,omitempty"`
		GroupChangePhoto     vk.BoolInt `json:"group_change_photo,omitempty"`
		GroupOfficersEdit    vk.BoolInt `json:"group_officers_edit,omitempty"`
		MessageAllow         vk.BoolInt `json:"message_allow,omitempty"`
		MessageDeny          vk.BoolInt `json:"message_deny,omitempty"`
		WallRepost           vk.BoolInt `json:"wall_repost,omitempty"`
		UserBlock            vk.BoolInt `json:"user_block,omitempty"`
		UserUnblock          vk.BoolInt `json:"user_unblock,omitempty"`
		MessagesEdit         vk.BoolInt `json:"messages_edit,omitempty"`
		MessageTypingState   vk.BoolInt `json:"message_typing_state,omitempty"`
		LeadFormsNew         vk.BoolInt `json:"lead_forms_new,omitempty"`
	} `json:"events,omitempty"`
}

GroupsGetLongPollSettingsResponse is response for Groups.GetLongPollSettings

type GroupsGetMembersParams

type GroupsGetMembersParams struct {
	// ID or screen name of the community.
	GroupID string `url:"group_id,omitempty"`
	// Sort order. Available values: 'id_asc', 'id_desc', 'time_asc', 'time_desc'. 'time_asc' and 'time_desc' are availavle only if the method is called by the group's 'moderator'.
	Sort string `url:"sort,omitempty"`
	// Offset needed to return a specific subset of community members.
	Offset int `url:"offset,omitempty"`
	// Number of community members to return.
	Count int `url:"count,omitempty"`
	// List of additional fields to be returned. Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// *'friends' – only friends in this community will be returned,, *'unsure' – only those who pressed 'I may attend' will be returned (if it's an event).
	Filter string `url:"filter,omitempty"`
}

GroupsGetMembersParams are params for Groups.GetMembers

type GroupsGetMembersResponse

type GroupsGetMembersResponse struct {
	// Total members number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
}

GroupsGetMembersResponse is response for Groups.GetMembers

type GroupsGetParams

type GroupsGetParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// '1' — to return complete information about a user's communities, '0' — to return a list of community IDs without any additional fields (default),
	Extended bool `url:"extended,omitempty"`
	// Types of communities to return: 'admin' — to return communities administered by the user , 'editor' — to return communities where the user is an administrator or editor, 'moder' — to return communities where the user is an administrator, editor, or moderator, 'groups' — to return only groups, 'publics' — to return only public pages, 'events' — to return only events
	Filter CSVStringSlice `url:"filter,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Offset needed to return a specific subset of communities.
	Offset int `url:"offset,omitempty"`
	// Number of communities to return.
	Count int `url:"count,omitempty"`
}

GroupsGetParams are params for Groups.Get

type GroupsGetRequestsParams

type GroupsGetRequestsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

GroupsGetRequestsParams are params for Groups.GetRequests

type GroupsGetRequestsResponse

type GroupsGetRequestsResponse struct {
	// Total communities number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
}

GroupsGetRequestsResponse is response for Groups.GetRequests

type GroupsGetResponse

type GroupsGetResponse interface {
	// contains filtered or unexported methods
}

GroupsGetResponse is response for Groups.Get Either GroupsGetResponseNormal or GroupsGetResponseExtended, depending on Extended flag

type GroupsGetResponseExtended

type GroupsGetResponseExtended struct {
	// Total communities number
	Count int        `json:"count,omitempty"`
	Items []vk.Group `json:"items,omitempty"`
}

GroupsGetResponseExtended is extended version of GroupsGetResponse

type GroupsGetResponseNormal

type GroupsGetResponseNormal struct {
	// Total communities number
	Count int `json:"count,omitempty"`
	// Community ID
	Items []int `json:"items,omitempty"`
}

GroupsGetResponseNormal is non-extended version of GroupsGetResponse

type GroupsGetSettingsParams

type GroupsGetSettingsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

GroupsGetSettingsParams are params for Groups.GetSettings

type GroupsGetSettingsResponse

type GroupsGetSettingsResponse struct {
	// Community title
	Title string `json:"title,omitempty"`
	// Community description
	Description string `json:"description,omitempty"`
	// Community's page domain
	Address string `json:"address,omitempty"`
	// Wall settings
	Wall int `json:"wall,omitempty"`
	// Photos settings
	Photos int `json:"photos,omitempty"`
	// Video settings
	Video int `json:"video,omitempty"`
	// Audio settings
	Audio int `json:"audio,omitempty"`
	// Docs settings
	Docs int `json:"docs,omitempty"`
	// Topics settings
	Topics int `json:"topics,omitempty"`
	// Wiki settings
	Wiki int `json:"wiki,omitempty"`
	// Information whether the obscene filter is enabled
	ObsceneFilter vk.BoolInt `json:"obscene_filter,omitempty"`
	// Information about the group category
	PublicCategory int `json:"public_category,omitempty"`
	// Information about the group subcategory
	PublicSubcategory  int           `json:"public_subcategory,omitempty"`
	PublicCategoryList []vk.Category `json:"public_category_list,omitempty"`
	// Information whether the stopwords filter is enabled
	ObsceneStopwords vk.BoolInt `json:"obscene_stopwords,omitempty"`
	// The list of stop words
	ObsceneWords string `json:"obscene_words,omitempty"`
	// Community access settings
	Access int `json:"access,omitempty"`
	// Community subject ID
	Subject     int                     `json:"subject,omitempty"`
	SubjectList []vk.BaseObjectWithName `json:"subject_list,omitempty"`
	// URL of the RSS feed
	Rss string `json:"rss,omitempty"`
	// Community website
	Website string `json:"website,omitempty"`
}

GroupsGetSettingsResponse is response for Groups.GetSettings

type GroupsInviteParams

type GroupsInviteParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// User ID.
	UserID int `url:"user_id"`
}

GroupsInviteParams are params for Groups.Invite

type GroupsIsMemberParams

type GroupsIsMemberParams struct {
	// ID or screen name of the community.
	GroupID string `url:"group_id"`
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// User IDs.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// '1' — to return an extended response with additional fields. By default: '0'.
	Extended bool `url:"extended,omitempty"`
}

GroupsIsMemberParams are params for Groups.IsMember

type GroupsIsMemberResponse

type GroupsIsMemberResponse interface {
	// contains filtered or unexported methods
}

GroupsIsMemberResponse is response for Groups.IsMember Either GroupsIsMemberResponseNormal or GroupsIsMemberResponseExtended, depending on Extended flag

type GroupsIsMemberResponseExtended

type GroupsIsMemberResponseExtended struct {
	// Information whether user is a member of the group
	Member vk.BoolInt `json:"member,omitempty"`
	// Information whether user has been invited to the group
	Invitation vk.BoolInt `json:"invitation,omitempty"`
	// Information whether user has sent request to the group
	Request vk.BoolInt `json:"request,omitempty"`
}

GroupsIsMemberResponseExtended is extended version of GroupsIsMemberResponse

type GroupsIsMemberResponseNormal

type GroupsIsMemberResponseNormal vk.BoolInt

GroupsIsMemberResponseNormal is non-extended version of GroupsIsMemberResponse Information whether user is a member of the group

type GroupsJoinParams

type GroupsJoinParams struct {
	// ID or screen name of the community.
	GroupID int `url:"group_id,omitempty"`
	// Optional parameter which is taken into account when 'gid' belongs to the event: '1' — Perhaps I will attend, '0' — I will be there for sure (default), ,
	NotSure string `url:"not_sure,omitempty"`
}

GroupsJoinParams are params for Groups.Join

type GroupsLeaveParams

type GroupsLeaveParams struct {
	// ID or screen name of the community.
	GroupID int `url:"group_id"`
}

GroupsLeaveParams are params for Groups.Leave

type GroupsRemoveUserParams

type GroupsRemoveUserParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// User ID.
	UserID int `url:"user_id"`
}

GroupsRemoveUserParams are params for Groups.RemoveUser

type GroupsReorderLinkParams

type GroupsReorderLinkParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Link ID.
	LinkID int `url:"link_id"`
	// ID of the link after which to place the link with 'link_id'.
	After int `url:"after,omitempty"`
}

GroupsReorderLinkParams are params for Groups.ReorderLink

type GroupsSearchParams

type GroupsSearchParams struct {
	// Search query string.
	Q string `url:"q"`
	// Community type. Possible values: 'group, page, event.'
	Type string `url:"type,omitempty"`
	// Country ID.
	CountryID int `url:"country_id,omitempty"`
	// City ID. If this parameter is transmitted, country_id is ignored.
	CityID int `url:"city_id,omitempty"`
	// '1' — to return only upcoming events. Works with the 'type' = 'event' only.
	Future bool `url:"future,omitempty"`
	// '1' — to return communities with enabled market only.
	Market bool `url:"market,omitempty"`
	// Sort order. Possible values: *'0' — default sorting (similar the full version of the site),, *'1' — by growth speed,, *'2'— by the "day attendance/members number" ratio,, *'3' — by the "Likes number/members number" ratio,, *'4' — by the "comments number/members number" ratio,, *'5' — by the "boards entries number/members number" ratio.
	Sort int `url:"sort,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of communities to return. "Note that you can not receive more than first thousand of results, regardless of 'count' and 'offset' values."
	Count int `url:"count,omitempty"`
}

GroupsSearchParams are params for Groups.Search

type GroupsSearchResponse

type GroupsSearchResponse struct {
	// Total communities number
	Count int        `json:"count,omitempty"`
	Items []vk.Group `json:"items,omitempty"`
}

GroupsSearchResponse is response for Groups.Search

type GroupsSetCallbackSettingsParams

type GroupsSetCallbackSettingsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Server ID.
	ServerID   int    `url:"server_id,omitempty"`
	APIVersion string `url:"api_version,omitempty"`
	// A new incoming message has been received ('0' — disabled, '1' — enabled).
	MessageNew bool `url:"message_new,omitempty"`
	// A new outcoming message has been received ('0' — disabled, '1' — enabled).
	MessageReply bool `url:"message_reply,omitempty"`
	// Allowed messages notifications ('0' — disabled, '1' — enabled).
	MessageAllow bool `url:"message_allow,omitempty"`
	// Denied messages notifications ('0' — disabled, '1' — enabled).
	MessageDeny        bool `url:"message_deny,omitempty"`
	MessageTypingState bool `url:"message_typing_state,omitempty"`
	// New photos notifications ('0' — disabled, '1' — enabled).
	PhotoNew bool `url:"photo_new,omitempty"`
	// New audios notifications ('0' — disabled, '1' — enabled).
	AudioNew bool `url:"audio_new,omitempty"`
	// New videos notifications ('0' — disabled, '1' — enabled).
	VideoNew bool `url:"video_new,omitempty"`
	// New wall replies notifications ('0' — disabled, '1' — enabled).
	WallReplyNew bool `url:"wall_reply_new,omitempty"`
	// Wall replies edited notifications ('0' — disabled, '1' — enabled).
	WallReplyEdit bool `url:"wall_reply_edit,omitempty"`
	// A wall comment has been deleted ('0' — disabled, '1' — enabled).
	WallReplyDelete bool `url:"wall_reply_delete,omitempty"`
	// A wall comment has been restored ('0' — disabled, '1' — enabled).
	WallReplyRestore bool `url:"wall_reply_restore,omitempty"`
	// New wall posts notifications ('0' — disabled, '1' — enabled).
	WallPostNew bool `url:"wall_post_new,omitempty"`
	// New wall posts notifications ('0' — disabled, '1' — enabled).
	WallRepost bool `url:"wall_repost,omitempty"`
	// New board posts notifications ('0' — disabled, '1' — enabled).
	BoardPostNew bool `url:"board_post_new,omitempty"`
	// Board posts edited notifications ('0' — disabled, '1' — enabled).
	BoardPostEdit bool `url:"board_post_edit,omitempty"`
	// Board posts restored notifications ('0' — disabled, '1' — enabled).
	BoardPostRestore bool `url:"board_post_restore,omitempty"`
	// Board posts deleted notifications ('0' — disabled, '1' — enabled).
	BoardPostDelete bool `url:"board_post_delete,omitempty"`
	// New comment to photo notifications ('0' — disabled, '1' — enabled).
	PhotoCommentNew bool `url:"photo_comment_new,omitempty"`
	// A photo comment has been edited ('0' — disabled, '1' — enabled).
	PhotoCommentEdit bool `url:"photo_comment_edit,omitempty"`
	// A photo comment has been deleted ('0' — disabled, '1' — enabled).
	PhotoCommentDelete bool `url:"photo_comment_delete,omitempty"`
	// A photo comment has been restored ('0' — disabled, '1' — enabled).
	PhotoCommentRestore bool `url:"photo_comment_restore,omitempty"`
	// New comment to video notifications ('0' — disabled, '1' — enabled).
	VideoCommentNew bool `url:"video_comment_new,omitempty"`
	// A video comment has been edited ('0' — disabled, '1' — enabled).
	VideoCommentEdit bool `url:"video_comment_edit,omitempty"`
	// A video comment has been deleted ('0' — disabled, '1' — enabled).
	VideoCommentDelete bool `url:"video_comment_delete,omitempty"`
	// A video comment has been restored ('0' — disabled, '1' — enabled).
	VideoCommentRestore bool `url:"video_comment_restore,omitempty"`
	// New comment to market item notifications ('0' — disabled, '1' — enabled).
	MarketCommentNew bool `url:"market_comment_new,omitempty"`
	// A market comment has been edited ('0' — disabled, '1' — enabled).
	MarketCommentEdit bool `url:"market_comment_edit,omitempty"`
	// A market comment has been deleted ('0' — disabled, '1' — enabled).
	MarketCommentDelete bool `url:"market_comment_delete,omitempty"`
	// A market comment has been restored ('0' — disabled, '1' — enabled).
	MarketCommentRestore bool `url:"market_comment_restore,omitempty"`
	// A vote in a public poll has been added ('0' — disabled, '1' — enabled).
	PollVoteNew bool `url:"poll_vote_new,omitempty"`
	// Joined community notifications ('0' — disabled, '1' — enabled).
	GroupJoin bool `url:"group_join,omitempty"`
	// Left community notifications ('0' — disabled, '1' — enabled).
	GroupLeave          bool `url:"group_leave,omitempty"`
	GroupChangeSettings bool `url:"group_change_settings,omitempty"`
	GroupChangePhoto    bool `url:"group_change_photo,omitempty"`
	GroupOfficersEdit   bool `url:"group_officers_edit,omitempty"`
	// User added to community blacklist
	UserBlock bool `url:"user_block,omitempty"`
	// User removed from community blacklist
	UserUnblock bool `url:"user_unblock,omitempty"`
	// New form in lead forms
	LeadFormsNew bool `url:"lead_forms_new,omitempty"`
}

GroupsSetCallbackSettingsParams are params for Groups.SetCallbackSettings

type GroupsSetLongPollSettingsParams

type GroupsSetLongPollSettingsParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Sets whether Long Poll is enabled ('0' — disabled, '1' — enabled).
	Enabled bool `url:"enabled,omitempty"`
	// A new incoming message has been received ('0' — disabled, '1' — enabled).
	MessageNew bool `url:"message_new,omitempty"`
	// A new outcoming message has been received ('0' — disabled, '1' — enabled).
	MessageReply bool `url:"message_reply,omitempty"`
	// Allowed messages notifications ('0' — disabled, '1' — enabled).
	MessageAllow bool `url:"message_allow,omitempty"`
	// Denied messages notifications ('0' — disabled, '1' — enabled).
	MessageDeny bool `url:"message_deny,omitempty"`
	// A message has been edited ('0' — disabled, '1' — enabled).
	MessageEdit        bool `url:"message_edit,omitempty"`
	MessageTypingState bool `url:"message_typing_state,omitempty"`
	// New photos notifications ('0' — disabled, '1' — enabled).
	PhotoNew bool `url:"photo_new,omitempty"`
	// New audios notifications ('0' — disabled, '1' — enabled).
	AudioNew bool `url:"audio_new,omitempty"`
	// New videos notifications ('0' — disabled, '1' — enabled).
	VideoNew bool `url:"video_new,omitempty"`
	// New wall replies notifications ('0' — disabled, '1' — enabled).
	WallReplyNew bool `url:"wall_reply_new,omitempty"`
	// Wall replies edited notifications ('0' — disabled, '1' — enabled).
	WallReplyEdit bool `url:"wall_reply_edit,omitempty"`
	// A wall comment has been deleted ('0' — disabled, '1' — enabled).
	WallReplyDelete bool `url:"wall_reply_delete,omitempty"`
	// A wall comment has been restored ('0' — disabled, '1' — enabled).
	WallReplyRestore bool `url:"wall_reply_restore,omitempty"`
	// New wall posts notifications ('0' — disabled, '1' — enabled).
	WallPostNew bool `url:"wall_post_new,omitempty"`
	// New wall posts notifications ('0' — disabled, '1' — enabled).
	WallRepost bool `url:"wall_repost,omitempty"`
	// New board posts notifications ('0' — disabled, '1' — enabled).
	BoardPostNew bool `url:"board_post_new,omitempty"`
	// Board posts edited notifications ('0' — disabled, '1' — enabled).
	BoardPostEdit bool `url:"board_post_edit,omitempty"`
	// Board posts restored notifications ('0' — disabled, '1' — enabled).
	BoardPostRestore bool `url:"board_post_restore,omitempty"`
	// Board posts deleted notifications ('0' — disabled, '1' — enabled).
	BoardPostDelete bool `url:"board_post_delete,omitempty"`
	// New comment to photo notifications ('0' — disabled, '1' — enabled).
	PhotoCommentNew bool `url:"photo_comment_new,omitempty"`
	// A photo comment has been edited ('0' — disabled, '1' — enabled).
	PhotoCommentEdit bool `url:"photo_comment_edit,omitempty"`
	// A photo comment has been deleted ('0' — disabled, '1' — enabled).
	PhotoCommentDelete bool `url:"photo_comment_delete,omitempty"`
	// A photo comment has been restored ('0' — disabled, '1' — enabled).
	PhotoCommentRestore bool `url:"photo_comment_restore,omitempty"`
	// New comment to video notifications ('0' — disabled, '1' — enabled).
	VideoCommentNew bool `url:"video_comment_new,omitempty"`
	// A video comment has been edited ('0' — disabled, '1' — enabled).
	VideoCommentEdit bool `url:"video_comment_edit,omitempty"`
	// A video comment has been deleted ('0' — disabled, '1' — enabled).
	VideoCommentDelete bool `url:"video_comment_delete,omitempty"`
	// A video comment has been restored ('0' — disabled, '1' — enabled).
	VideoCommentRestore bool `url:"video_comment_restore,omitempty"`
	// New comment to market item notifications ('0' — disabled, '1' — enabled).
	MarketCommentNew bool `url:"market_comment_new,omitempty"`
	// A market comment has been edited ('0' — disabled, '1' — enabled).
	MarketCommentEdit bool `url:"market_comment_edit,omitempty"`
	// A market comment has been deleted ('0' — disabled, '1' — enabled).
	MarketCommentDelete bool `url:"market_comment_delete,omitempty"`
	// A market comment has been restored ('0' — disabled, '1' — enabled).
	MarketCommentRestore bool `url:"market_comment_restore,omitempty"`
	// A vote in a public poll has been added ('0' — disabled, '1' — enabled).
	PollVoteNew bool `url:"poll_vote_new,omitempty"`
	// Joined community notifications ('0' — disabled, '1' — enabled).
	GroupJoin bool `url:"group_join,omitempty"`
	// Left community notifications ('0' — disabled, '1' — enabled).
	GroupLeave          bool `url:"group_leave,omitempty"`
	GroupChangeSettings bool `url:"group_change_settings,omitempty"`
	GroupChangePhoto    bool `url:"group_change_photo,omitempty"`
	GroupOfficersEdit   bool `url:"group_officers_edit,omitempty"`
	// User added to community blacklist
	UserBlock bool `url:"user_block,omitempty"`
	// User removed from community blacklist
	UserUnblock bool `url:"user_unblock,omitempty"`
}

GroupsSetLongPollSettingsParams are params for Groups.SetLongPollSettings

type GroupsUnbanParams

type GroupsUnbanParams struct {
	GroupID int `url:"group_id"`
	OwnerID int `url:"owner_id,omitempty"`
}

GroupsUnbanParams are params for Groups.Unban

type Leads

type Leads struct {
	API vk.API
}

Leads implements VK API namespace `leads`

func (Leads) CheckUser

func (v Leads) CheckUser(params LeadsCheckUserParams) (*LeadsCheckUserResponse, error)

CheckUser Checks if the user can start the lead.

func (Leads) Complete

func (v Leads) Complete(params LeadsCompleteParams) (*LeadsCompleteResponse, error)

Complete Completes the lead started by user.

func (Leads) GetStats

func (v Leads) GetStats(params LeadsGetStatsParams) (*LeadsGetStatsResponse, error)

GetStats Returns lead stats data.

func (Leads) GetUsers

func (v Leads) GetUsers(params LeadsGetUsersParams) (LeadsGetUsersResponse, error)

GetUsers Returns a list of last user actions for the offer.

func (Leads) MetricHit

func (v Leads) MetricHit(params LeadsMetricHitParams) (*LeadsMetricHitResponse, error)

MetricHit Counts the metric event.

func (Leads) Start

func (v Leads) Start(params LeadsStartParams) (*LeadsStartResponse, error)

Start Creates new session for the user passing the offer.

type LeadsCheckUserParams

type LeadsCheckUserParams struct {
	// Lead ID.
	LeadID int `url:"lead_id"`
	// Value to be return in 'result' field when test mode is used.
	TestResult int  `url:"test_result,omitempty"`
	TestMode   bool `url:"test_mode,omitempty"`
	AutoStart  bool `url:"auto_start,omitempty"`
	// User age.
	Age int `url:"age,omitempty"`
	// User country code.
	Country string `url:"country,omitempty"`
}

LeadsCheckUserParams are params for Leads.CheckUser

type LeadsCheckUserResponse

type LeadsCheckUserResponse struct {
	// Information whether user can start the lead
	Result string `json:"result,omitempty"`
	// Reason why user can't start the lead
	Reason string `json:"reason,omitempty"`
	// URL user should open to start the lead
	StartLink string `json:"start_link,omitempty"`
	// Session ID
	Sid string `json:"sid,omitempty"`
}

LeadsCheckUserResponse is response for Leads.CheckUser

type LeadsCompleteParams

type LeadsCompleteParams struct {
	// Session obtained as GET parameter when session started.
	VkSid string `url:"vk_sid"`
	// Secret key from the lead testing interface.
	Secret string `url:"secret"`
	// Comment text.
	Comment string `url:"comment,omitempty"`
}

LeadsCompleteParams are params for Leads.Complete

type LeadsCompleteResponse

type LeadsCompleteResponse struct {
	// Offer limit
	Limit int `json:"limit,omitempty"`
	// Amount of spent votes
	Spent int `json:"spent,omitempty"`
	// Offer cost
	Cost int `json:"cost,omitempty"`
	// Information whether test mode is enabled
	TestMode vk.BoolInt `json:"test_mode,omitempty"`
	Success  vk.BoolInt `json:"success,omitempty"`
}

LeadsCompleteResponse is response for Leads.Complete

type LeadsGetStatsParams

type LeadsGetStatsParams struct {
	// Lead ID.
	LeadID int `url:"lead_id"`
	// Secret key obtained from the lead testing interface.
	Secret string `url:"secret,omitempty"`
	// Day to start stats from (YYYY_MM_DD, e.g.2011-09-17).
	DateStart string `url:"date_start,omitempty"`
	// Day to finish stats (YYYY_MM_DD, e.g.2011-09-17).
	DateEnd string `url:"date_end,omitempty"`
}

LeadsGetStatsParams are params for Leads.GetStats

type LeadsGetStatsResponse

type LeadsGetStatsResponse struct {
	// Lead limit
	Limit int `json:"limit,omitempty"`
	// Amount of spent votes
	Spent int `json:"spent,omitempty"`
	// Offer cost
	Cost int `json:"cost,omitempty"`
	// Impressions number
	Impressions int `json:"impressions,omitempty"`
	// Started offers number
	Started int `json:"started,omitempty"`
	// Completed offers number
	Completed int `json:"completed,omitempty"`
	Days      struct {
		// Impressions number
		Impressions int `json:"impressions,omitempty"`
		// Started offers number
		Started int `json:"started,omitempty"`
		// Completed offers number
		Completed int `json:"completed,omitempty"`
		// Amount of spent votes
		Spent int `json:"spent,omitempty"`
	} `json:"days,omitempty"`
}

LeadsGetStatsResponse is response for Leads.GetStats

type LeadsGetUsersParams

type LeadsGetUsersParams struct {
	// Offer ID.
	OfferID int `url:"offer_id"`
	// Secret key obtained in the lead testing interface.
	Secret string `url:"secret"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// Action type. Possible values: *'0' — start,, *'1' — finish,, *'2' — blocking users,, *'3' — start in a test mode,, *'4' — finish in a test mode.
	Status int `url:"status,omitempty"`
	// Sort order. Possible values: *'1' — chronological,, *'0' — reverse chronological.
	Reverse bool `url:"reverse,omitempty"`
}

LeadsGetUsersParams are params for Leads.GetUsers

type LeadsGetUsersResponse

type LeadsGetUsersResponse []struct {
	// User ID
	UID int `json:"uid,omitempty"`
	// Application ID
	Aid int `json:"aid,omitempty"`
	// Session string ID
	Sid string `json:"sid,omitempty"`
	// Date when the action has been started in Unixtime
	Date int `json:"date,omitempty"`
	// Action type
	Status int `json:"status,omitempty"`
	// Information whether test mode is enabled
	TestMode vk.BoolInt `json:"test_mode,omitempty"`
	// Start date in Unixtime (for status=2)
	StartDate int `json:"start_date,omitempty"`
	// Comment text
	Comment string `json:"comment,omitempty"`
}

LeadsGetUsersResponse is response for Leads.GetUsers

type LeadsMetricHitParams

type LeadsMetricHitParams struct {
	// Metric data obtained in the lead interface.
	Data string `url:"data"`
}

LeadsMetricHitParams are params for Leads.MetricHit

type LeadsMetricHitResponse

type LeadsMetricHitResponse struct {
	// Information whether request has been processed successfully
	Result bool `json:"result,omitempty"`
	// Redirect link
	RedirectLink string `json:"redirect_link,omitempty"`
}

LeadsMetricHitResponse is response for Leads.MetricHit

type LeadsStartParams

type LeadsStartParams struct {
	// Lead ID.
	LeadID int `url:"lead_id"`
	// Secret key from the lead testing interface.
	Secret   string `url:"secret"`
	UID      int    `url:"uid,omitempty"`
	Aid      int    `url:"aid,omitempty"`
	TestMode bool   `url:"test_mode,omitempty"`
	Force    bool   `url:"force,omitempty"`
}

LeadsStartParams are params for Leads.Start

type LeadsStartResponse

type LeadsStartResponse struct {
	// Information whether test mode is enabled
	TestMode vk.BoolInt `json:"test_mode,omitempty"`
	// Session data
	VkSid string `json:"vk_sid,omitempty"`
}

LeadsStartResponse is response for Leads.Start

type Likes

type Likes struct {
	API vk.API
}

Likes implements VK API namespace `likes`

func (Likes) Add

func (v Likes) Add(params LikesAddParams) (*LikesAddResponse, error)

Add Adds the specified object to the 'Likes' list of the current user.

func (Likes) Delete

func (v Likes) Delete(params LikesDeleteParams) (*LikesDeleteResponse, error)

Delete Deletes the specified object from the 'Likes' list of the current user.

func (Likes) GetList

func (v Likes) GetList(params LikesGetListParams) (LikesGetListResponse, error)

GetList Returns a list of IDs of users who added the specified object to their 'Likes' list.

func (Likes) IsLiked

func (v Likes) IsLiked(params LikesIsLikedParams) (*LikesIsLikedResponse, error)

IsLiked Checks for the object in the 'Likes' list of the specified user.

type LikesAddParams

type LikesAddParams struct {
	// Object type: 'post' — post on user or community wall, 'comment' — comment on a wall post, 'photo' — photo, 'audio' — audio, 'video' — video, 'note' — note, 'photo_comment' — comment on the photo, 'video_comment' — comment on the video, 'topic_comment' — comment in the discussion, 'sitepage' — page of the site where the [vk.com/dev/Like|Like widget] is installed
	Type string `url:"type"`
	// ID of the user or community that owns the object.
	OwnerID int `url:"owner_id,omitempty"`
	// Object ID.
	ItemID int `url:"item_id"`
	// Access key required for an object owned by a private entity.
	AccessKey string `url:"access_key,omitempty"`
}

LikesAddParams are params for Likes.Add

type LikesAddResponse

type LikesAddResponse struct {
	// Total likes number
	Likes int `json:"likes,omitempty"`
}

LikesAddResponse is response for Likes.Add

type LikesDeleteParams

type LikesDeleteParams struct {
	// Object type: 'post' — post on user or community wall, 'comment' — comment on a wall post, 'photo' — photo, 'audio' — audio, 'video' — video, 'note' — note, 'photo_comment' — comment on the photo, 'video_comment' — comment on the video, 'topic_comment' — comment in the discussion, 'sitepage' — page of the site where the [vk.com/dev/Like|Like widget] is installed
	Type string `url:"type"`
	// ID of the user or community that owns the object.
	OwnerID int `url:"owner_id,omitempty"`
	// Object ID.
	ItemID int `url:"item_id"`
}

LikesDeleteParams are params for Likes.Delete

type LikesDeleteResponse

type LikesDeleteResponse struct {
	// Total likes number
	Likes int `json:"likes,omitempty"`
}

LikesDeleteResponse is response for Likes.Delete

type LikesGetListParams

type LikesGetListParams struct {
	// , Object type: 'post' — post on user or community wall, 'comment' — comment on a wall post, 'photo' — photo, 'audio' — audio, 'video' — video, 'note' — note, 'photo_comment' — comment on the photo, 'video_comment' — comment on the video, 'topic_comment' — comment in the discussion, 'sitepage' — page of the site where the [vk.com/dev/Like|Like widget] is installed
	Type string `url:"type"`
	// ID of the user, community, or application that owns the object. If the 'type' parameter is set as 'sitepage', the application ID is passed as 'owner_id'. Use negative value for a community id. If the 'type' parameter is not set, the 'owner_id' is assumed to be either the current user or the same application ID as if the 'type' parameter was set to 'sitepage'.
	OwnerID int `url:"owner_id,omitempty"`
	// Object ID. If 'type' is set as 'sitepage', 'item_id' can include the 'page_id' parameter value used during initialization of the [vk.com/dev/Like|Like widget].
	ItemID int `url:"item_id,omitempty"`
	// URL of the page where the [vk.com/dev/Like|Like widget] is installed. Used instead of the 'item_id' parameter.
	PageURL string `url:"page_url,omitempty"`
	// Filters to apply: 'likes' — returns information about all users who liked the object (default), 'copies' — returns information only about users who told their friends about the object
	Filter string `url:"filter,omitempty"`
	// Specifies which users are returned: '1' — to return only the current user's friends, '0' — to return all users (default)
	FriendsOnly bool `url:"friends_only,omitempty"`
	// Specifies whether extended information will be returned. '1' — to return extended information about users and communities from the 'Likes' list, '0' — to return no additional information (default)
	Extended bool `url:"extended,omitempty"`
	// Offset needed to select a specific subset of users.
	Offset int `url:"offset,omitempty"`
	// Number of user IDs to return (maximum '1000'). Default is '100' if 'friends_only' is set to '0', otherwise, the default is '10' if 'friends_only' is set to '1'.
	Count   int  `url:"count,omitempty"`
	SkipOwn bool `url:"skip_own,omitempty"`
}

LikesGetListParams are params for Likes.GetList

type LikesGetListResponse

type LikesGetListResponse interface {
	// contains filtered or unexported methods
}

LikesGetListResponse is response for Likes.GetList Either LikesGetListResponseNormal or LikesGetListResponseExtended, depending on Extended flag

type LikesGetListResponseExtended

type LikesGetListResponseExtended struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

LikesGetListResponseExtended is extended version of LikesGetListResponse

type LikesGetListResponseNormal

type LikesGetListResponseNormal struct {
	// Total number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
}

LikesGetListResponseNormal is non-extended version of LikesGetListResponse

type LikesIsLikedParams

type LikesIsLikedParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Object type: 'post' — post on user or community wall, 'comment' — comment on a wall post, 'photo' — photo, 'audio' — audio, 'video' — video, 'note' — note, 'photo_comment' — comment on the photo, 'video_comment' — comment on the video, 'topic_comment' — comment in the discussion
	Type string `url:"type"`
	// ID of the user or community that owns the object.
	OwnerID int `url:"owner_id,omitempty"`
	// Object ID.
	ItemID int `url:"item_id"`
}

LikesIsLikedParams are params for Likes.IsLiked

type LikesIsLikedResponse

type LikesIsLikedResponse struct {
	// Information whether user liked the object
	Liked vk.BoolInt `json:"liked,omitempty"`
	// Information whether user reposted the object
	Copied vk.BoolInt `json:"copied,omitempty"`
}

LikesIsLikedResponse is response for Likes.IsLiked

type Market

type Market struct {
	API vk.API
}

Market implements VK API namespace `market`

func (Market) Add

func (v Market) Add(params MarketAddParams) (*MarketAddResponse, error)

Add Ads a new item to the market.

func (Market) AddAlbum

AddAlbum Creates new collection of items

func (Market) AddToAlbum

func (v Market) AddToAlbum(params MarketAddToAlbumParams) (bool, error)

AddToAlbum Adds an item to one or multiple collections.

func (Market) CreateComment

CreateComment Creates a new comment for an item.

func (Market) Delete

func (v Market) Delete(params MarketDeleteParams) (bool, error)

Delete Deletes an item.

func (Market) DeleteAlbum

func (v Market) DeleteAlbum(params MarketDeleteAlbumParams) (bool, error)

DeleteAlbum Deletes a collection of items.

func (Market) DeleteComment

func (v Market) DeleteComment(params MarketDeleteCommentParams) (bool, error)

DeleteComment Deletes an item's comment

func (Market) Edit

func (v Market) Edit(params MarketEditParams) (bool, error)

Edit Edits an item.

func (Market) EditAlbum

func (v Market) EditAlbum(params MarketEditAlbumParams) (bool, error)

EditAlbum Edits a collection of items

func (Market) EditComment

func (v Market) EditComment(params MarketEditCommentParams) (bool, error)

EditComment Chages item comment's text

func (Market) Get

func (v Market) Get(params MarketGetParams) (MarketGetResponse, error)

Get Returns items list for a community.

func (Market) GetAlbumByID

GetAlbumByID Returns items album's data

func (Market) GetAlbums

GetAlbums Returns community's collections list.

func (Market) GetByID

GetByID Returns information about market items by their ids.

func (Market) GetCategories

GetCategories Returns a list of market categories.

func (Market) GetComments

GetComments Returns comments list for an item.

func (Market) RemoveFromAlbum

func (v Market) RemoveFromAlbum(params MarketRemoveFromAlbumParams) (bool, error)

RemoveFromAlbum Removes an item from one or multiple collections.

func (Market) ReorderAlbums

func (v Market) ReorderAlbums(params MarketReorderAlbumsParams) (bool, error)

ReorderAlbums Reorders the collections list.

func (Market) ReorderItems

func (v Market) ReorderItems(params MarketReorderItemsParams) (bool, error)

ReorderItems Changes item place in a collection.

func (Market) Report

func (v Market) Report(params MarketReportParams) (bool, error)

Report Sends a complaint to the item.

func (Market) ReportComment

func (v Market) ReportComment(params MarketReportCommentParams) (bool, error)

ReportComment Sends a complaint to the item's comment.

func (Market) Restore

func (v Market) Restore(params MarketRestoreParams) (bool, error)

Restore Restores recently deleted item

func (Market) RestoreComment

func (v Market) RestoreComment(params MarketRestoreCommentParams) (bool, error)

RestoreComment Restores a recently deleted comment

func (Market) Search

Search Searches market items in a community's catalog

type MarketAddAlbumParams

type MarketAddAlbumParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Collection title.
	Title string `url:"title"`
	// Cover photo ID.
	PhotoID int `url:"photo_id,omitempty"`
	// Set as main ('1' – set, '0' – no).
	MainAlbum bool `url:"main_album,omitempty"`
}

MarketAddAlbumParams are params for Market.AddAlbum

type MarketAddAlbumResponse

type MarketAddAlbumResponse struct {
	// Album ID
	MarketAlbumID int `json:"market_album_id,omitempty"`
}

MarketAddAlbumResponse is response for Market.AddAlbum

type MarketAddParams

type MarketAddParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item name.
	Name string `url:"name"`
	// Item description.
	Description string `url:"description"`
	// Item category ID.
	CategoryID int `url:"category_id"`
	// Item price.
	Price float32 `url:"price"`
	// Item status ('1' — deleted, '0' — not deleted).
	Deleted bool `url:"deleted,omitempty"`
	// Cover photo ID.
	MainPhotoID int `url:"main_photo_id"`
	// IDs of additional photos.
	PhotoIDs CSVIntSlice `url:"photo_ids,omitempty"`
	// Url for button in market item.
	URL string `url:"url,omitempty"`
}

MarketAddParams are params for Market.Add

type MarketAddResponse

type MarketAddResponse struct {
	// Item ID
	MarketItemID int `json:"market_item_id,omitempty"`
}

MarketAddResponse is response for Market.Add

type MarketAddToAlbumParams

type MarketAddToAlbumParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// Collections IDs to add item to.
	AlbumIDs CSVIntSlice `url:"album_ids"`
}

MarketAddToAlbumParams are params for Market.AddToAlbum

type MarketCreateCommentParams

type MarketCreateCommentParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// Comment text (required if 'attachments' parameter is not specified)
	Message string `url:"message,omitempty"`
	// Comma-separated list of objects attached to a comment. The field is submitted the following way: , "'<owner_id>_<media_id>,<owner_id>_<media_id>'", , ” - media attachment type: "'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document", , '<owner_id>' - media owner id, '<media_id>' - media attachment id, , For example: "photo100172_166443618,photo66748_265827614",
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// '1' - comment will be published on behalf of a community, '0' - on behalf of a user (by default).
	FromGroup bool `url:"from_group,omitempty"`
	// ID of a comment to reply with current comment to.
	ReplyToComment int `url:"reply_to_comment,omitempty"`
	// Sticker ID.
	StickerID int `url:"sticker_id,omitempty"`
	// Random value to avoid resending one comment.
	GUID string `url:"guid,omitempty"`
}

MarketCreateCommentParams are params for Market.CreateComment

type MarketCreateCommentResponse

type MarketCreateCommentResponse int

MarketCreateCommentResponse is response for Market.CreateComment Comment ID

type MarketDeleteAlbumParams

type MarketDeleteAlbumParams struct {
	// ID of an collection owner community.
	OwnerID int `url:"owner_id"`
	// Collection ID.
	AlbumID int `url:"album_id"`
}

MarketDeleteAlbumParams are params for Market.DeleteAlbum

type MarketDeleteCommentParams

type MarketDeleteCommentParams struct {
	// identifier of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
	OwnerID int `url:"owner_id"`
	// comment id
	CommentID int `url:"comment_id"`
}

MarketDeleteCommentParams are params for Market.DeleteComment

type MarketDeleteParams

type MarketDeleteParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
}

MarketDeleteParams are params for Market.Delete

type MarketEditAlbumParams

type MarketEditAlbumParams struct {
	// ID of an collection owner community.
	OwnerID int `url:"owner_id"`
	// Collection ID.
	AlbumID int `url:"album_id"`
	// Collection title.
	Title string `url:"title"`
	// Cover photo id
	PhotoID int `url:"photo_id,omitempty"`
	// Set as main ('1' – set, '0' – no).
	MainAlbum bool `url:"main_album,omitempty"`
}

MarketEditAlbumParams are params for Market.EditAlbum

type MarketEditCommentParams

type MarketEditCommentParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// New comment text (required if 'attachments' are not specified), , 2048 symbols maximum.
	Message string `url:"message,omitempty"`
	// Comma-separated list of objects attached to a comment. The field is submitted the following way: , "'<owner_id>_<media_id>,<owner_id>_<media_id>'", , ” - media attachment type: "'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document", , '<owner_id>' - media owner id, '<media_id>' - media attachment id, , For example: "photo100172_166443618,photo66748_265827614",
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

MarketEditCommentParams are params for Market.EditComment

type MarketEditParams

type MarketEditParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// Item name.
	Name string `url:"name"`
	// Item description.
	Description string `url:"description"`
	// Item category ID.
	CategoryID int `url:"category_id"`
	// Item price.
	Price float32 `url:"price"`
	// Item status ('1' — deleted, '0' — not deleted).
	Deleted bool `url:"deleted,omitempty"`
	// Cover photo ID.
	MainPhotoID int `url:"main_photo_id"`
	// IDs of additional photos.
	PhotoIDs CSVIntSlice `url:"photo_ids,omitempty"`
	// Url for button in market item.
	URL string `url:"url,omitempty"`
}

MarketEditParams are params for Market.Edit

type MarketGetAlbumByIDParams

type MarketGetAlbumByIDParams struct {
	// identifier of an album owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
	OwnerID int `url:"owner_id"`
	// collections identifiers to obtain data from
	AlbumIDs CSVIntSlice `url:"album_ids"`
}

MarketGetAlbumByIDParams are params for Market.GetAlbumByID

type MarketGetAlbumByIDResponse

type MarketGetAlbumByIDResponse struct {
	// Total number
	Count int              `json:"count,omitempty"`
	Items []vk.MarketAlbum `json:"items,omitempty"`
}

MarketGetAlbumByIDResponse is response for Market.GetAlbumByID

type MarketGetAlbumsParams

type MarketGetAlbumsParams struct {
	// ID of an items owner community.
	OwnerID int `url:"owner_id"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of items to return.
	Count int `url:"count,omitempty"`
}

MarketGetAlbumsParams are params for Market.GetAlbums

type MarketGetAlbumsResponse

type MarketGetAlbumsResponse struct {
	// Total number
	Count int              `json:"count,omitempty"`
	Items []vk.MarketAlbum `json:"items,omitempty"`
}

MarketGetAlbumsResponse is response for Market.GetAlbums

type MarketGetByIDParams

type MarketGetByIDParams struct {
	// Comma-separated ids list: {user id}_{item id}. If an item belongs to a community -{community id} is used. " 'Videos' value example: , '-4363_136089719,13245770_137352259'"
	ItemIDs CSVStringSlice `url:"item_ids"`
	// '1' – to return additional fields: 'likes, can_comment, car_repost, photos'. By default: '0'.
	Extended bool `url:"extended,omitempty"`
}

MarketGetByIDParams are params for Market.GetByID

type MarketGetByIDResponse

type MarketGetByIDResponse interface {
	// contains filtered or unexported methods
}

MarketGetByIDResponse is response for Market.GetByID Either MarketGetByIDResponseNormal or MarketGetByIDResponseExtended, depending on Extended flag

type MarketGetByIDResponseExtended

type MarketGetByIDResponseExtended struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketGetByIDResponseExtended is extended version of MarketGetByIDResponse

type MarketGetByIDResponseNormal

type MarketGetByIDResponseNormal struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketGetByIDResponseNormal is non-extended version of MarketGetByIDResponse

type MarketGetCategoriesParams

type MarketGetCategoriesParams struct {
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
}

MarketGetCategoriesParams are params for Market.GetCategories

type MarketGetCategoriesResponse

type MarketGetCategoriesResponse struct {
	// Total number
	Count int                 `json:"count,omitempty"`
	Items []vk.MarketCategory `json:"items,omitempty"`
}

MarketGetCategoriesResponse is response for Market.GetCategories

type MarketGetCommentsParams

type MarketGetCommentsParams struct {
	// ID of an item owner community
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// '1' — to return likes info.
	NeedLikes bool `url:"need_likes,omitempty"`
	// ID of a comment to start a list from (details below).
	StartCommentID int `url:"start_comment_id,omitempty"`
	Offset         int `url:"offset,omitempty"`
	// Number of results to return.
	Count int `url:"count,omitempty"`
	// Sort order ('asc' — from old to new, 'desc' — from new to old)
	Sort string `url:"sort,omitempty"`
	// '1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.
	Extended bool `url:"extended,omitempty"`
	// List of additional profile fields to return. See the [vk.com/dev/fields|details]
	Fields CSVStringSlice `url:"fields,omitempty"`
}

MarketGetCommentsParams are params for Market.GetComments

type MarketGetCommentsResponse

type MarketGetCommentsResponse struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Comment `json:"items,omitempty"`
}

MarketGetCommentsResponse is response for Market.GetComments

type MarketGetParams

type MarketGetParams struct {
	// ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
	OwnerID int `url:"owner_id"`
	AlbumID int `url:"album_id,omitempty"`
	// Number of items to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// '1' – method will return additional fields: 'likes, can_comment, car_repost, photos'. These parameters are not returned by default.
	Extended bool `url:"extended,omitempty"`
}

MarketGetParams are params for Market.Get

type MarketGetResponse

type MarketGetResponse interface {
	// contains filtered or unexported methods
}

MarketGetResponse is response for Market.Get Either MarketGetResponseNormal or MarketGetResponseExtended, depending on Extended flag

type MarketGetResponseExtended

type MarketGetResponseExtended struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketGetResponseExtended is extended version of MarketGetResponse

type MarketGetResponseNormal

type MarketGetResponseNormal struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketGetResponseNormal is non-extended version of MarketGetResponse

type MarketRemoveFromAlbumParams

type MarketRemoveFromAlbumParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// Collections IDs to remove item from.
	AlbumIDs CSVIntSlice `url:"album_ids"`
}

MarketRemoveFromAlbumParams are params for Market.RemoveFromAlbum

type MarketReorderAlbumsParams

type MarketReorderAlbumsParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Collection ID.
	AlbumID int `url:"album_id"`
	// ID of a collection to place current collection before it.
	Before int `url:"before,omitempty"`
	// ID of a collection to place current collection after it.
	After int `url:"after,omitempty"`
}

MarketReorderAlbumsParams are params for Market.ReorderAlbums

type MarketReorderItemsParams

type MarketReorderItemsParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// ID of a collection to reorder items in. Set 0 to reorder full items list.
	AlbumID int `url:"album_id,omitempty"`
	// Item ID.
	ItemID int `url:"item_id"`
	// ID of an item to place current item before it.
	Before int `url:"before,omitempty"`
	// ID of an item to place current item after it.
	After int `url:"after,omitempty"`
}

MarketReorderItemsParams are params for Market.ReorderItems

type MarketReportCommentParams

type MarketReportCommentParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// Complaint reason. Possible values: *'0' — spam,, *'1' — child porn,, *'2' — extremism,, *'3' — violence,, *'4' — drugs propaganda,, *'5' — adult materials,, *'6' — insult.
	Reason int `url:"reason"`
}

MarketReportCommentParams are params for Market.ReportComment

type MarketReportParams

type MarketReportParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Item ID.
	ItemID int `url:"item_id"`
	// Complaint reason. Possible values: *'0' — spam,, *'1' — child porn,, *'2' — extremism,, *'3' — violence,, *'4' — drugs propaganda,, *'5' — adult materials,, *'6' — insult.
	Reason int `url:"reason,omitempty"`
}

MarketReportParams are params for Market.Report

type MarketRestoreCommentParams

type MarketRestoreCommentParams struct {
	// identifier of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
	OwnerID int `url:"owner_id"`
	// deleted comment id
	CommentID int `url:"comment_id"`
}

MarketRestoreCommentParams are params for Market.RestoreComment

type MarketRestoreParams

type MarketRestoreParams struct {
	// ID of an item owner community.
	OwnerID int `url:"owner_id"`
	// Deleted item ID.
	ItemID int `url:"item_id"`
}

MarketRestoreParams are params for Market.Restore

type MarketSearchParams

type MarketSearchParams struct {
	// ID of an items owner community.
	OwnerID int `url:"owner_id"`
	AlbumID int `url:"album_id,omitempty"`
	// Search query, for example "pink slippers".
	Q string `url:"q,omitempty"`
	// Minimum item price value.
	PriceFrom int `url:"price_from,omitempty"`
	// Maximum item price value.
	PriceTo int `url:"price_to,omitempty"`
	// Comma-separated tag IDs list.
	Tags CSVIntSlice `url:"tags,omitempty"`
	Sort int         `url:"sort,omitempty"`
	// '0' — do not use reverse order, '1' — use reverse order
	Rev int `url:"rev,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// Number of items to return.
	Count int `url:"count,omitempty"`
	// '1' – to return additional fields: 'likes, can_comment, car_repost, photos'. By default: '0'.
	Extended bool `url:"extended,omitempty"`
	Status   int  `url:"status,omitempty"`
}

MarketSearchParams are params for Market.Search

type MarketSearchResponse

type MarketSearchResponse interface {
	// contains filtered or unexported methods
}

MarketSearchResponse is response for Market.Search Either MarketSearchResponseNormal or MarketSearchResponseExtended, depending on Extended flag

type MarketSearchResponseExtended

type MarketSearchResponseExtended struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketSearchResponseExtended is extended version of MarketSearchResponse

type MarketSearchResponseNormal

type MarketSearchResponseNormal struct {
	// Total number
	Count int             `json:"count,omitempty"`
	Items []vk.MarketItem `json:"items,omitempty"`
}

MarketSearchResponseNormal is non-extended version of MarketSearchResponse

type Messages

type Messages struct {
	API vk.API
}

Messages implements VK API namespace `messages`

func (Messages) AddChatUser

func (v Messages) AddChatUser(params MessagesAddChatUserParams) (bool, error)

AddChatUser Adds a new user to a chat.

func (Messages) AllowMessagesFromGroup

func (v Messages) AllowMessagesFromGroup(params MessagesAllowMessagesFromGroupParams) (bool, error)

AllowMessagesFromGroup Allows sending messages from community to the current user.

func (Messages) CreateChat

CreateChat Creates a chat with several participants.

func (Messages) Delete

Delete Deletes one or more messages.

func (Messages) DeleteChatPhoto

DeleteChatPhoto Deletes a chat's cover picture.

func (Messages) DeleteConversation

DeleteConversation Deletes all private messages in a conversation.

func (Messages) DenyMessagesFromGroup

func (v Messages) DenyMessagesFromGroup(params MessagesDenyMessagesFromGroupParams) (bool, error)

DenyMessagesFromGroup Denies sending message from community to the current user.

func (Messages) Edit

func (v Messages) Edit(params MessagesEditParams) (bool, error)

Edit Edits the message.

func (Messages) EditChat

func (v Messages) EditChat(params MessagesEditChatParams) (bool, error)

EditChat Edits the title of a chat.

func (Messages) GetByConversationMessageID

GetByConversationMessageID Returns messages by their IDs within the conversation.

func (Messages) GetByID

GetByID Returns messages by their IDs.

func (Messages) GetChatPreview

GetChatPreview does messages.getChatPreview

func (Messages) GetConversationMembers

GetConversationMembers Returns a list of IDs of users participating in a chat.

func (Messages) GetConversations

GetConversations Returns a list of the current user's conversations.

func (Messages) GetConversationsByID

GetConversationsByID Returns conversations by their IDs

func (Messages) GetHistory

GetHistory Returns message history for the specified user or group chat.

func (Messages) GetHistoryAttachments

GetHistoryAttachments Returns media files from the dialog or group chat.

GetInviteLink does messages.getInviteLink

func (Messages) GetLastActivity

GetLastActivity Returns a user's current status and date of last activity.

func (Messages) GetLongPollHistory

GetLongPollHistory Returns updates in user's private messages.

func (Messages) GetLongPollServer

GetLongPollServer Returns data required for connection to a Long Poll server.

func (Messages) IsMessagesFromGroupAllowed

IsMessagesFromGroupAllowed Returns information whether sending messages from the community to current user is allowed.

JoinChatByInviteLink does messages.joinChatByInviteLink

func (Messages) MarkAsAnsweredConversation

func (v Messages) MarkAsAnsweredConversation(params MessagesMarkAsAnsweredConversationParams) (bool, error)

MarkAsAnsweredConversation Marks and unmarks conversations as unanswered.

func (Messages) MarkAsImportant

MarkAsImportant Marks and unmarks messages as important (starred).

func (Messages) MarkAsImportantConversation

func (v Messages) MarkAsImportantConversation(params MessagesMarkAsImportantConversationParams) (bool, error)

MarkAsImportantConversation Marks and unmarks conversations as important.

func (Messages) MarkAsRead

func (v Messages) MarkAsRead(params MessagesMarkAsReadParams) (bool, error)

MarkAsRead Marks messages as read.

func (Messages) Pin

Pin Pin a message.

func (Messages) RemoveChatUser

func (v Messages) RemoveChatUser(params MessagesRemoveChatUserParams) (bool, error)

RemoveChatUser Allows the current user to leave a chat or, if the current user started the chat, allows the user to remove another user from the chat.

func (Messages) Restore

func (v Messages) Restore(params MessagesRestoreParams) (bool, error)

Restore Restores a deleted message.

func (Messages) Search

Search Returns a list of the current user's private messages that match search criteria.

func (Messages) SearchConversations

SearchConversations Returns a list of the current user's conversations that match search criteria.

func (Messages) Send

Send Sends a message.

func (Messages) SetActivity

func (v Messages) SetActivity(params MessagesSetActivityParams) (bool, error)

SetActivity Changes the status of a user as typing in a conversation.

func (Messages) SetChatPhoto

SetChatPhoto Sets a previously-uploaded picture as the cover picture of a chat.

func (Messages) Unpin

func (v Messages) Unpin(params MessagesUnpinParams) (bool, error)

Unpin does messages.unpin

type MessagesAddChatUserParams

type MessagesAddChatUserParams struct {
	// Chat ID.
	ChatID int `url:"chat_id"`
	// ID of the user to be added to the chat.
	UserID int `url:"user_id"`
}

MessagesAddChatUserParams are params for Messages.AddChatUser

type MessagesAllowMessagesFromGroupParams

type MessagesAllowMessagesFromGroupParams struct {
	// Group ID.
	GroupID int    `url:"group_id"`
	Key     string `url:"key,omitempty"`
}

MessagesAllowMessagesFromGroupParams are params for Messages.AllowMessagesFromGroup

type MessagesCreateChatParams

type MessagesCreateChatParams struct {
	// IDs of the users to be added to the chat.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// Chat title.
	Title string `url:"title,omitempty"`
}

MessagesCreateChatParams are params for Messages.CreateChat

type MessagesCreateChatResponse

type MessagesCreateChatResponse int

MessagesCreateChatResponse is response for Messages.CreateChat Chat ID

type MessagesDeleteChatPhotoParams

type MessagesDeleteChatPhotoParams struct {
	// Chat ID.
	ChatID  int `url:"chat_id"`
	GroupID int `url:"group_id,omitempty"`
}

MessagesDeleteChatPhotoParams are params for Messages.DeleteChatPhoto

type MessagesDeleteChatPhotoResponse

type MessagesDeleteChatPhotoResponse struct {
	// Service message ID
	MessageID int     `json:"message_id,omitempty"`
	Chat      vk.Chat `json:"chat,omitempty"`
}

MessagesDeleteChatPhotoResponse is response for Messages.DeleteChatPhoto

type MessagesDeleteConversationParams

type MessagesDeleteConversationParams struct {
	// User ID. To clear a chat history use 'chat_id'
	UserID int `url:"user_id,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// Offset needed to delete a specific subset of conversations.
	Offset int `url:"offset,omitempty"`
	// Number of conversations to delete. "NOTE: If the number of messages exceeds the maximum, the method shall be called several times."
	Count int `url:"count,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesDeleteConversationParams are params for Messages.DeleteConversation

type MessagesDeleteConversationResponse

type MessagesDeleteConversationResponse struct {
	// Id of the last message, that was deleted
	LastDeletedID int `json:"last_deleted_id,omitempty"`
}

MessagesDeleteConversationResponse is response for Messages.DeleteConversation

type MessagesDeleteParams

type MessagesDeleteParams struct {
	// Message IDs.
	MessageIDs CSVIntSlice `url:"message_ids,omitempty"`
	// '1' — to mark message as spam.
	Spam bool `url:"spam,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
	// '1' — delete message for for all.
	DeleteForAll bool `url:"delete_for_all,omitempty"`
}

MessagesDeleteParams are params for Messages.Delete

type MessagesDeleteResponse

type MessagesDeleteResponse ArrayOnMeth

MessagesDeleteResponse is response for Messages.Delete

type MessagesDenyMessagesFromGroupParams

type MessagesDenyMessagesFromGroupParams struct {
	// Group ID.
	GroupID int `url:"group_id"`
}

MessagesDenyMessagesFromGroupParams are params for Messages.DenyMessagesFromGroup

type MessagesEditChatParams

type MessagesEditChatParams struct {
	// Chat ID.
	ChatID int `url:"chat_id"`
	// New title of the chat.
	Title string `url:"title"`
}

MessagesEditChatParams are params for Messages.EditChat

type MessagesEditParams

type MessagesEditParams struct {
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id"`
	// (Required if 'attachments' is not set.) Text of the message.
	Message   string `url:"message,omitempty"`
	MessageID int    `url:"message_id"`
	// Geographical latitude of a check-in, in degrees (from -90 to 90).
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude of a check-in, in degrees (from -180 to 180).
	Long float32 `url:"long,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '<owner_id>' — ID of the media attachment owner. '<media_id>' — media attachment ID. Example: "photo100172_166443618"
	Attachment CSVStringSlice `url:"attachment,omitempty"`
	// '1' — to keep forwarded, messages.
	KeepForwardMessages bool `url:"keep_forward_messages,omitempty"`
	// '1' — to keep attached snippets.
	KeepSnippets bool `url:"keep_snippets,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID        int  `url:"group_id,omitempty"`
	DontParseLinks bool `url:"dont_parse_links,omitempty"`
}

MessagesEditParams are params for Messages.Edit

type MessagesGetByConversationMessageIDParams

type MessagesGetByConversationMessageIDParams struct {
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id"`
	// Conversation message IDs.
	ConversationMessageIDs CSVIntSlice `url:"conversation_message_ids"`
	// Information whether the response should be extended
	Extended bool `url:"extended,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetByConversationMessageIDParams are params for Messages.GetByConversationMessageID

type MessagesGetByConversationMessageIDResponse

type MessagesGetByConversationMessageIDResponse struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Message `json:"items,omitempty"`
}

MessagesGetByConversationMessageIDResponse is response for Messages.GetByConversationMessageID

type MessagesGetByIDParams

type MessagesGetByIDParams struct {
	// Message IDs.
	MessageIDs CSVIntSlice `url:"message_ids"`
	// Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
	PreviewLength int `url:"preview_length,omitempty"`
	// Information whether the response should be extended
	Extended bool `url:"extended,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetByIDParams are params for Messages.GetByID

type MessagesGetByIDResponse

type MessagesGetByIDResponse struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Message `json:"items,omitempty"`
}

MessagesGetByIDResponse is response for Messages.GetByID

type MessagesGetChatPreviewParams

type MessagesGetChatPreviewParams struct {
	// Invitation link.
	Link string `url:"link"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

MessagesGetChatPreviewParams are params for Messages.GetChatPreview

type MessagesGetChatPreviewResponse

type MessagesGetChatPreviewResponse struct {
	Preview struct {
		AdminID      int    `json:"admin_id,omitempty"`
		MembersCount int    `json:"members_count,omitempty"`
		Members      []int  `json:"members,omitempty"`
		Title        string `json:"title,omitempty"`
		LocalID      int    `json:"local_id,omitempty"`
		Joined       bool   `json:"joined,omitempty"`
	} `json:"preview,omitempty"`
	Profiles []vk.User `json:"profiles,omitempty"`
}

MessagesGetChatPreviewResponse is response for Messages.GetChatPreview

type MessagesGetConversationMembersParams

type MessagesGetConversationMembersParams struct {
	// Peer ID.
	PeerID int `url:"peer_id"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetConversationMembersParams are params for Messages.GetConversationMembers

type MessagesGetConversationMembersResponse

type MessagesGetConversationMembersResponse struct {
	// Chat members count
	Count int `json:"count,omitempty"`
	Items []struct {
		MemberID  int  `json:"member_id,omitempty"`
		JoinDate  int  `json:"join_date,omitempty"`
		InvitedBy int  `json:"invited_by,omitempty"`
		IsOwner   bool `json:"is_owner,omitempty"`
		IsAdmin   bool `json:"is_admin,omitempty"`
		// Is it possible for user to kick this member
		CanKick bool `json:"can_kick,omitempty"`
	} `json:"items,omitempty"`
	ChatRestrictions struct {
		// Only admins can invite users to this chat
		OnlyAdminsInvite bool `json:"only_admins_invite,omitempty"`
		// Only admins can kick users from this chat
		OnlyAdminsKick bool `json:"only_admins_kick,omitempty"`
		// Only admins can change chat info
		OnlyAdminsEditInfo bool `json:"only_admins_edit_info,omitempty"`
		// Only admins can edit pinned message
		OnlyAdminsEditPin bool `json:"only_admins_edit_pin,omitempty"`
		// Only admins can promote users to admins
		AdminsPromoteUsers bool `json:"admins_promote_users,omitempty"`
	} `json:"chat_restrictions,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

MessagesGetConversationMembersResponse is response for Messages.GetConversationMembers

type MessagesGetConversationsByIDParams

type MessagesGetConversationsByIDParams struct {
	// Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerIDs CSVIntSlice `url:"peer_ids"`
	// Return extended properties
	Extended bool `url:"extended,omitempty"`
	// Profile and communities fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetConversationsByIDParams are params for Messages.GetConversationsByID

type MessagesGetConversationsByIDResponse

type MessagesGetConversationsByIDResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		Conversation vk.Conversation `json:"conversation,omitempty"`
		LastMessage  vk.Message      `json:"last_message,omitempty"`
	} `json:"items,omitempty"`
}

MessagesGetConversationsByIDResponse is response for Messages.GetConversationsByID

type MessagesGetConversationsParams

type MessagesGetConversationsParams struct {
	// Offset needed to return a specific subset of conversations.
	Offset int `url:"offset,omitempty"`
	// Number of conversations to return.
	Count int `url:"count,omitempty"`
	// Filter to apply: 'all' — all conversations, 'unread' — conversations with unread messages, 'important' — conversations, marked as important (only for community messages), 'unanswered' — conversations, marked as unanswered (only for community messages)
	Filter string `url:"filter,omitempty"`
	// '1' — return extra information about users and communities
	Extended bool `url:"extended,omitempty"`
	// ID of the message from what to return dialogs.
	StartMessageID int `url:"start_message_id,omitempty"`
	// Profile and communities fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetConversationsParams are params for Messages.GetConversations

type MessagesGetConversationsResponse

type MessagesGetConversationsResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	// Unread dialogs number
	UnreadCount int `json:"unread_count,omitempty"`
	Items       []struct {
		Conversation vk.Conversation `json:"conversation,omitempty"`
		LastMessage  vk.Message      `json:"last_message,omitempty"`
	} `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

MessagesGetConversationsResponse is response for Messages.GetConversations

type MessagesGetHistoryAttachmentsParams

type MessagesGetHistoryAttachmentsParams struct {
	// Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"
	PeerID int `url:"peer_id"`
	// Type of media files to return: *'photo',, *'video',, *'audio',, *'doc',, *'link'.,*'market'.,*'wall'.,*'share'
	MediaType string `url:"media_type,omitempty"`
	// Message ID to start return results from.
	StartFrom string `url:"start_from,omitempty"`
	// Number of objects to return.
	Count int `url:"count,omitempty"`
	// '1' — to return photo sizes in a
	PhotoSizes bool `url:"photo_sizes,omitempty"`
	// Additional profile [vk.com/dev/fields|fields] to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetHistoryAttachmentsParams are params for Messages.GetHistoryAttachments

type MessagesGetHistoryAttachmentsResponse

type MessagesGetHistoryAttachmentsResponse struct {
	Items []struct {
		// Message ID
		MessageID  int           `json:"message_id,omitempty"`
		Attachment vk.Attachment `json:"attachment,omitempty"`
	} `json:"items,omitempty"`
	// Value for pagination
	NextFrom string `json:"next_from,omitempty"`
}

MessagesGetHistoryAttachmentsResponse is response for Messages.GetHistoryAttachments

type MessagesGetHistoryParams

type MessagesGetHistoryParams struct {
	// Offset needed to return a specific subset of messages.
	Offset int `url:"offset,omitempty"`
	// Number of messages to return.
	Count int `url:"count,omitempty"`
	// ID of the user whose message history you want to return.
	UserID int `url:"user_id,omitempty"`
	PeerID int `url:"peer_id,omitempty"`
	// Starting message ID from which to return history.
	StartMessageID int `url:"start_message_id,omitempty"`
	// Sort order: '1' — return messages in chronological order. '0' — return messages in reverse chronological order.
	Rev int `url:"rev,omitempty"`
	// Information whether the response should be extended
	Extended bool `url:"extended,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetHistoryParams are params for Messages.GetHistory

type MessagesGetHistoryResponse

type MessagesGetHistoryResponse struct {
	// Total number
	Count    int          `json:"count,omitempty"`
	Items    []vk.Message `json:"items,omitempty"`
	Profiles []vk.User    `json:"profiles,omitempty"`
	Groups   []vk.Group   `json:"groups,omitempty"`
}

MessagesGetHistoryResponse is response for Messages.GetHistory

type MessagesGetInviteLinkParams

type MessagesGetInviteLinkParams struct {
	// Destination ID.
	PeerID int `url:"peer_id"`
	// 1 — to generate new link (revoke previous), 0 — to return previous link.
	Reset bool `url:"reset,omitempty"`
	// Group ID
	GroupID int `url:"group_id,omitempty"`
}

MessagesGetInviteLinkParams are params for Messages.GetInviteLink

type MessagesGetInviteLinkResponse

type MessagesGetInviteLinkResponse struct {
	Link string `json:"link,omitempty"`
}

MessagesGetInviteLinkResponse is response for Messages.GetInviteLink

type MessagesGetLastActivityParams

type MessagesGetLastActivityParams struct {
	// User ID.
	UserID int `url:"user_id"`
}

MessagesGetLastActivityParams are params for Messages.GetLastActivity

type MessagesGetLastActivityResponse

type MessagesGetLastActivityResponse struct {
	// Information whether user is online
	Online vk.BoolInt `json:"online,omitempty"`
	// Time when user was online in Unixtime
	Time int `json:"time,omitempty"`
}

MessagesGetLastActivityResponse is response for Messages.GetLastActivity

type MessagesGetLongPollHistoryParams

type MessagesGetLongPollHistoryParams struct {
	// Last value of the 'ts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
	TS int `url:"ts,omitempty"`
	// Lsat value of 'pts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
	Pts int `url:"pts,omitempty"`
	// Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
	PreviewLength int `url:"preview_length,omitempty"`
	// '1' — to return history with online users only.
	Onlines bool `url:"onlines,omitempty"`
	// Additional profile [vk.com/dev/fields|fields] to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Maximum number of events to return.
	EventsLimit int `url:"events_limit,omitempty"`
	// Maximum number of messages to return.
	MsgsLimit int `url:"msgs_limit,omitempty"`
	// Maximum ID of the message among existing ones in the local copy. Both messages received with API methods (for example, , ), and data received from a Long Poll server (events with code 4) are taken into account.
	MaxMsgID int `url:"max_msg_id,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID   int `url:"group_id,omitempty"`
	LpVersion int `url:"lp_version,omitempty"`
}

MessagesGetLongPollHistoryParams are params for Messages.GetLongPollHistory

type MessagesGetLongPollHistoryResponse

type MessagesGetLongPollHistoryResponse struct {
	// Longpoll event value
	History  [][]int    `json:"history,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
	Messages struct {
		// Total number
		Count int          `json:"count,omitempty"`
		Items []vk.Message `json:"items,omitempty"`
	} `json:"messages,omitempty"`
	Profiles []vk.User `json:"profiles,omitempty"`
	Chats    []vk.Chat `json:"chats,omitempty"`
	// Persistence timestamp
	NewPts int `json:"new_pts,omitempty"`
	// Has more
	More vk.BoolInt `json:"more,omitempty"`
}

MessagesGetLongPollHistoryResponse is response for Messages.GetLongPollHistory

type MessagesGetLongPollServerParams

type MessagesGetLongPollServerParams struct {
	// '1' — to return the 'pts' field, needed for the [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
	NeedPts bool `url:"need_pts,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
	// Long poll version
	LpVersion int `url:"lp_version,omitempty"`
}

MessagesGetLongPollServerParams are params for Messages.GetLongPollServer

type MessagesGetLongPollServerResponse

type MessagesGetLongPollServerResponse struct {
	// Key
	Key string `json:"key,omitempty"`
	// Server URL
	Server string `json:"server,omitempty"`
	// Timestamp
	TS int `json:"ts,omitempty"`
	// Persistent timestamp
	Pts int `json:"pts,omitempty"`
}

MessagesGetLongPollServerResponse is response for Messages.GetLongPollServer

type MessagesIsMessagesFromGroupAllowedParams

type MessagesIsMessagesFromGroupAllowedParams struct {
	// Group ID.
	GroupID int `url:"group_id"`
	// User ID.
	UserID int `url:"user_id"`
}

MessagesIsMessagesFromGroupAllowedParams are params for Messages.IsMessagesFromGroupAllowed

type MessagesIsMessagesFromGroupAllowedResponse

type MessagesIsMessagesFromGroupAllowedResponse struct {
	IsAllowed vk.BoolInt `json:"is_allowed,omitempty"`
}

MessagesIsMessagesFromGroupAllowedResponse is response for Messages.IsMessagesFromGroupAllowed

type MessagesJoinChatByInviteLinkParams

type MessagesJoinChatByInviteLinkParams struct {
	// Invitation link.
	Link string `url:"link"`
}

MessagesJoinChatByInviteLinkParams are params for Messages.JoinChatByInviteLink

type MessagesJoinChatByInviteLinkResponse

type MessagesJoinChatByInviteLinkResponse struct {
	ChatID int `json:"chat_id,omitempty"`
}

MessagesJoinChatByInviteLinkResponse is response for Messages.JoinChatByInviteLink

type MessagesMarkAsAnsweredConversationParams

type MessagesMarkAsAnsweredConversationParams struct {
	// ID of conversation to mark as important.
	PeerID int `url:"peer_id"`
	// '1' — to mark as answered, '0' — to remove the mark
	Answered bool `url:"answered,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesMarkAsAnsweredConversationParams are params for Messages.MarkAsAnsweredConversation

type MessagesMarkAsImportantConversationParams

type MessagesMarkAsImportantConversationParams struct {
	// ID of conversation to mark as important.
	PeerID int `url:"peer_id"`
	// '1' — to add a star (mark as important), '0' — to remove the star
	Important bool `url:"important,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesMarkAsImportantConversationParams are params for Messages.MarkAsImportantConversation

type MessagesMarkAsImportantParams

type MessagesMarkAsImportantParams struct {
	// IDs of messages to mark as important.
	MessageIDs CSVIntSlice `url:"message_ids,omitempty"`
	// '1' — to add a star (mark as important), '0' — to remove the star
	Important int `url:"important,omitempty"`
}

MessagesMarkAsImportantParams are params for Messages.MarkAsImportant

type MessagesMarkAsImportantResponse

type MessagesMarkAsImportantResponse []int

MessagesMarkAsImportantResponse is response for Messages.MarkAsImportant Messages IDs

type MessagesMarkAsReadParams

type MessagesMarkAsReadParams struct {
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// Message ID to start from.
	StartMessageID int `url:"start_message_id,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesMarkAsReadParams are params for Messages.MarkAsRead

type MessagesPinParams

type MessagesPinParams struct {
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
	PeerID    int `url:"peer_id"`
	MessageID int `url:"message_id,omitempty"`
}

MessagesPinParams are params for Messages.Pin

type MessagesPinResponse

type MessagesPinResponse vk.Message

MessagesPinResponse is response for Messages.Pin

type MessagesRemoveChatUserParams

type MessagesRemoveChatUserParams struct {
	// Chat ID.
	ChatID int `url:"chat_id"`
	// ID of the user to be removed from the chat.
	UserID   int `url:"user_id,omitempty"`
	MemberID int `url:"member_id,omitempty"`
}

MessagesRemoveChatUserParams are params for Messages.RemoveChatUser

type MessagesRestoreParams

type MessagesRestoreParams struct {
	// ID of a previously-deleted message to restore.
	MessageID int `url:"message_id"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesRestoreParams are params for Messages.Restore

type MessagesSearchConversationsParams

type MessagesSearchConversationsParams struct {
	// Search query string.
	Q string `url:"q,omitempty"`
	// Maximum number of results.
	Count int `url:"count,omitempty"`
	// '1' — return extra information about users and communities
	Extended bool `url:"extended,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with user access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesSearchConversationsParams are params for Messages.SearchConversations

type MessagesSearchConversationsResponse

type MessagesSearchConversationsResponse struct {
	// Total results number
	Count    int               `json:"count,omitempty"`
	Items    []vk.Conversation `json:"items,omitempty"`
	Profiles []vk.User         `json:"profiles,omitempty"`
	Groups   []vk.Group        `json:"groups,omitempty"`
}

MessagesSearchConversationsResponse is response for Messages.SearchConversations

type MessagesSearchParams

type MessagesSearchParams struct {
	// Search query string.
	Q string `url:"q,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// Date to search message before in Unixtime.
	Date int `url:"date,omitempty"`
	// Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
	PreviewLength int `url:"preview_length,omitempty"`
	// Offset needed to return a specific subset of messages.
	Offset int `url:"offset,omitempty"`
	// Number of messages to return.
	Count    int            `url:"count,omitempty"`
	Extended bool           `url:"extended,omitempty"`
	Fields   CSVStringSlice `url:"fields,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesSearchParams are params for Messages.Search

type MessagesSearchResponse

type MessagesSearchResponse struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Message `json:"items,omitempty"`
}

MessagesSearchResponse is response for Messages.Search

type MessagesSendParams

type MessagesSendParams struct {
	// User ID (by default — current user).
	UserID int `url:"user_id,omitempty"`
	// Unique identifier to avoid resending the message.
	RandomID int `url:"random_id,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// User's short address (for example, 'illarionov').
	Domain string `url:"domain,omitempty"`
	// ID of conversation the message will relate to.
	ChatID int `url:"chat_id,omitempty"`
	// IDs of message recipients (if new conversation shall be started).
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// (Required if 'attachments' is not set.) Text of the message.
	Message string `url:"message,omitempty"`
	// Geographical latitude of a check-in, in degrees (from -90 to 90).
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude of a check-in, in degrees (from -180 to 180).
	Long float32 `url:"long,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '<owner_id>' — ID of the media attachment owner. '<media_id>' — media attachment ID. Example: "photo100172_166443618"
	Attachment CSVStringSlice `url:"attachment,omitempty"`
	ReplyTo    int            `url:"reply_to,omitempty"`
	// ID of forwarded messages, separated with a comma. Listed messages of the sender will be shown in the message body at the recipient's. Example: "123,431,544"
	ForwardMessages CSVIntSlice `url:"forward_messages,omitempty"`
	// Sticker id.
	StickerID int `url:"sticker_id,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID        int    `url:"group_id,omitempty"`
	Keyboard       string `url:"keyboard,omitempty"`
	Payload        string `url:"payload,omitempty"`
	DontParseLinks bool   `url:"dont_parse_links,omitempty"`
}

MessagesSendParams are params for Messages.Send

type MessagesSendResponse

type MessagesSendResponse int

MessagesSendResponse is response for Messages.Send Message ID

type MessagesSetActivityParams

type MessagesSetActivityParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// 'typing' — user has started to type.
	Type string `url:"type,omitempty"`
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
	// Group ID (for group messages with group access token)
	GroupID int `url:"group_id,omitempty"`
}

MessagesSetActivityParams are params for Messages.SetActivity

type MessagesSetChatPhotoParams

type MessagesSetChatPhotoParams struct {
	// Upload URL from the 'response' field returned by the [vk.com/dev/photos.getChatUploadServer|photos.getChatUploadServer] method upon successfully uploading an image.
	File string `url:"file"`
}

MessagesSetChatPhotoParams are params for Messages.SetChatPhoto

type MessagesSetChatPhotoResponse

type MessagesSetChatPhotoResponse struct {
	// Service message ID
	MessageID int     `json:"message_id,omitempty"`
	Chat      vk.Chat `json:"chat,omitempty"`
}

MessagesSetChatPhotoResponse is response for Messages.SetChatPhoto

type MessagesUnpinParams

type MessagesUnpinParams struct {
	PeerID  int `url:"peer_id"`
	GroupID int `url:"group_id,omitempty"`
}

MessagesUnpinParams are params for Messages.Unpin

type Newsfeed

type Newsfeed struct {
	API vk.API
}

Newsfeed implements VK API namespace `newsfeed`

func (Newsfeed) AddBan

func (v Newsfeed) AddBan(params NewsfeedAddBanParams) (bool, error)

AddBan Prevents news from specified users and communities from appearing in the current user's newsfeed.

func (Newsfeed) DeleteBan

func (v Newsfeed) DeleteBan(params NewsfeedDeleteBanParams) (bool, error)

DeleteBan Allows news from previously banned users and communities to be shown in the current user's newsfeed.

func (Newsfeed) DeleteList

func (v Newsfeed) DeleteList(params NewsfeedDeleteListParams) (bool, error)

DeleteList does newsfeed.deleteList

func (Newsfeed) Get

Get Returns data required to show newsfeed for the current user.

func (Newsfeed) GetBanned

GetBanned Returns a list of users and communities banned from the current user's newsfeed.

func (Newsfeed) GetComments

GetComments Returns a list of comments in the current user's newsfeed.

func (Newsfeed) GetLists

GetLists Returns a list of newsfeeds followed by the current user.

func (Newsfeed) GetMentions

GetMentions Returns a list of posts on user walls in which the current user is mentioned.

func (Newsfeed) GetRecommended

GetRecommended , Returns a list of newsfeeds recommended to the current user.

func (Newsfeed) GetSuggestedSources

GetSuggestedSources Returns communities and users that current user is suggested to follow.

func (Newsfeed) IgnoreItem

func (v Newsfeed) IgnoreItem(params NewsfeedIgnoreItemParams) (bool, error)

IgnoreItem Hides an item from the newsfeed.

func (Newsfeed) SaveList

SaveList Creates and edits user newsfeed lists

func (Newsfeed) Search

Search Returns search results by statuses.

func (Newsfeed) UnignoreItem

func (v Newsfeed) UnignoreItem(params NewsfeedUnignoreItemParams) (bool, error)

UnignoreItem Returns a hidden item to the newsfeed.

func (Newsfeed) Unsubscribe

func (v Newsfeed) Unsubscribe(params NewsfeedUnsubscribeParams) (bool, error)

Unsubscribe Unsubscribes the current user from specified newsfeeds.

type NewsfeedAddBanParams

type NewsfeedAddBanParams struct {
	UserIDs  CSVIntSlice `url:"user_ids,omitempty"`
	GroupIDs CSVIntSlice `url:"group_ids,omitempty"`
}

NewsfeedAddBanParams are params for Newsfeed.AddBan

type NewsfeedDeleteBanParams

type NewsfeedDeleteBanParams struct {
	UserIDs  CSVIntSlice `url:"user_ids,omitempty"`
	GroupIDs CSVIntSlice `url:"group_ids,omitempty"`
}

NewsfeedDeleteBanParams are params for Newsfeed.DeleteBan

type NewsfeedDeleteListParams

type NewsfeedDeleteListParams struct {
	ListID int `url:"list_id"`
}

NewsfeedDeleteListParams are params for Newsfeed.DeleteList

type NewsfeedGetBannedParams

type NewsfeedGetBannedParams struct {
	// '1' — return extra information about users and communities
	Extended bool `url:"extended,omitempty"`
	// Profile fields to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

NewsfeedGetBannedParams are params for Newsfeed.GetBanned

type NewsfeedGetBannedResponse

type NewsfeedGetBannedResponse interface {
	// contains filtered or unexported methods
}

NewsfeedGetBannedResponse is response for Newsfeed.GetBanned Either NewsfeedGetBannedResponseNormal or NewsfeedGetBannedResponseExtended, depending on Extended flag

type NewsfeedGetBannedResponseExtended

type NewsfeedGetBannedResponseExtended struct {
	Groups  []vk.User  `json:"groups,omitempty"`
	Members []vk.Group `json:"members,omitempty"`
}

NewsfeedGetBannedResponseExtended is extended version of NewsfeedGetBannedResponse

type NewsfeedGetBannedResponseNormal

type NewsfeedGetBannedResponseNormal struct {
	// Community ID
	Groups []int `json:"groups,omitempty"`
	// User ID
	Members []int `json:"members,omitempty"`
}

NewsfeedGetBannedResponseNormal is non-extended version of NewsfeedGetBannedResponse

type NewsfeedGetCommentsParams

type NewsfeedGetCommentsParams struct {
	// Number of comments to return. For auto feed, you can use the 'new_offset' parameter returned by this method.
	Count int `url:"count,omitempty"`
	// Filters to apply: 'post' — new comments on wall posts, 'photo' — new comments on photos, 'video' — new comments on videos, 'topic' — new comments on discussions, 'note' — new comments on notes,
	Filters CSVStringSlice `url:"filters,omitempty"`
	// Object ID, comments on repost of which shall be returned, e.g. 'wall1_45486'. (If the parameter is set, the 'filters' parameter is optional.),
	Reposts string `url:"reposts,omitempty"`
	// Earliest timestamp (in Unix time) of a comment to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a comment to return. By default, the current time.
	EndTime           int `url:"end_time,omitempty"`
	LastCommentsCount int `url:"last_comments_count,omitempty"`
	// Identificator needed to return the next page with results. Value for this parameter returns in 'next_from' field.
	StartFrom string `url:"start_from,omitempty"`
	// Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

NewsfeedGetCommentsParams are params for Newsfeed.GetComments

type NewsfeedGetCommentsResponse

type NewsfeedGetCommentsResponse struct {
	Items    []vk.NewsfeedItem `json:"items,omitempty"`
	Profiles []vk.User         `json:"profiles,omitempty"`
	Groups   []vk.Group        `json:"groups,omitempty"`
	// New from value
	NextFrom string `json:"next_from,omitempty"`
}

NewsfeedGetCommentsResponse is response for Newsfeed.GetComments

type NewsfeedGetListsParams

type NewsfeedGetListsParams struct {
	// numeric list identifiers.
	ListIDs CSVIntSlice `url:"list_ids,omitempty"`
	// Return additional list info
	Extended bool `url:"extended,omitempty"`
}

NewsfeedGetListsParams are params for Newsfeed.GetLists

type NewsfeedGetListsResponse

type NewsfeedGetListsResponse interface {
	// contains filtered or unexported methods
}

NewsfeedGetListsResponse is response for Newsfeed.GetLists Either NewsfeedGetListsResponseNormal or NewsfeedGetListsResponseExtended, depending on Extended flag

type NewsfeedGetListsResponseExtended

type NewsfeedGetListsResponseExtended struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

NewsfeedGetListsResponseExtended is extended version of NewsfeedGetListsResponse

type NewsfeedGetListsResponseNormal

type NewsfeedGetListsResponseNormal struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

NewsfeedGetListsResponseNormal is non-extended version of NewsfeedGetListsResponse

type NewsfeedGetMentionsParams

type NewsfeedGetMentionsParams struct {
	// Owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Earliest timestamp (in Unix time) of a post to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a post to return. By default, the current time.
	EndTime int `url:"end_time,omitempty"`
	// Offset needed to return a specific subset of posts.
	Offset int `url:"offset,omitempty"`
	// Number of posts to return.
	Count int `url:"count,omitempty"`
}

NewsfeedGetMentionsParams are params for Newsfeed.GetMentions

type NewsfeedGetMentionsResponse

type NewsfeedGetMentionsResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Post `json:"items,omitempty"`
}

NewsfeedGetMentionsResponse is response for Newsfeed.GetMentions

type NewsfeedGetParams

type NewsfeedGetParams struct {
	// Filters to apply: 'post' — new wall posts, 'photo' — new photos, 'photo_tag' — new photo tags, 'wall_photo' — new wall photos, 'friend' — new friends, 'note' — new notes
	Filters CSVStringSlice `url:"filters,omitempty"`
	// '1' — to return news items from banned sources
	ReturnBanned bool `url:"return_banned,omitempty"`
	// Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a news item to return. By default, the current time.
	EndTime int `url:"end_time,omitempty"`
	// Maximum number of photos to return. By default, '5'.
	MaxPhotos int `url:"max_photos,omitempty"`
	// Sources to obtain news from, separated by commas. User IDs can be specified in formats ” or 'u' , where ” is the user's friend ID. Community IDs can be specified in formats '-' or 'g' , where ” is the community ID. If the parameter is not set, all of the user's friends and communities are returned, except for banned sources, which can be obtained with the [vk.com/dev/newsfeed.getBanned|newsfeed.getBanned] method.
	SourceIDs CSVStringSlice `url:"source_ids,omitempty"`
	// identifier required to get the next page of results. Value for this parameter is returned in 'next_from' field in a reply.
	StartFrom string `url:"start_from,omitempty"`
	// Number of news items to return (default 50, maximum 100). For auto feed, you can use the 'new_offset' parameter returned by this method.
	Count int `url:"count,omitempty"`
	// Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
	Fields  CSVStringSlice `url:"fields,omitempty"`
	Section string         `url:"section,omitempty"`
}

NewsfeedGetParams are params for Newsfeed.Get

type NewsfeedGetRecommendedParams

type NewsfeedGetRecommendedParams struct {
	// Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a news item to return. By default, the current time.
	EndTime int `url:"end_time,omitempty"`
	// Maximum number of photos to return. By default, '5'.
	MaxPhotos int `url:"max_photos,omitempty"`
	// 'new_from' value obtained in previous call.
	StartFrom string `url:"start_from,omitempty"`
	// Number of news items to return.
	Count int `url:"count,omitempty"`
	// Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

NewsfeedGetRecommendedParams are params for Newsfeed.GetRecommended

type NewsfeedGetRecommendedResponse

type NewsfeedGetRecommendedResponse struct {
	Items    []vk.NewsfeedItem `json:"items,omitempty"`
	Profiles []vk.User         `json:"profiles,omitempty"`
	Groups   []vk.Group        `json:"groups,omitempty"`
	// New offset value
	NewOffset string `json:"new_offset,omitempty"`
	// New from value
	NewFrom string `json:"new_from,omitempty"`
}

NewsfeedGetRecommendedResponse is response for Newsfeed.GetRecommended

type NewsfeedGetResponse

type NewsfeedGetResponse struct {
	Items    []vk.NewsfeedItem `json:"items,omitempty"`
	Profiles []vk.User         `json:"profiles,omitempty"`
	Groups   []vk.Group        `json:"groups,omitempty"`
}

NewsfeedGetResponse is response for Newsfeed.Get

type NewsfeedGetSuggestedSourcesParams

type NewsfeedGetSuggestedSourcesParams struct {
	// offset required to choose a particular subset of communities or users.
	Offset int `url:"offset,omitempty"`
	// amount of communities or users to return.
	Count int `url:"count,omitempty"`
	// shuffle the returned list or not.
	Shuffle bool `url:"shuffle,omitempty"`
	// list of extra fields to be returned. See available fields for [vk.com/dev/fields|users] and [vk.com/dev/fields_groups|communities].
	Fields CSVStringSlice `url:"fields,omitempty"`
}

NewsfeedGetSuggestedSourcesParams are params for Newsfeed.GetSuggestedSources

type NewsfeedGetSuggestedSourcesResponse

type NewsfeedGetSuggestedSourcesResponse struct {
	// Total number
	Count int         `json:"count,omitempty"`
	Items genTODOType `json:"items,omitempty"`
}

NewsfeedGetSuggestedSourcesResponse is response for Newsfeed.GetSuggestedSources

type NewsfeedIgnoreItemParams

type NewsfeedIgnoreItemParams struct {
	// Item type. Possible values: *'wall' – post on the wall,, *'tag' – tag on a photo,, *'profilephoto' – profile photo,, *'video' – video,, *'audio' – audio.
	Type string `url:"type"`
	// Item owner's identifier (user or community), "Note that community id must be negative. 'owner_id=1' – user , 'owner_id=-1' – community "
	OwnerID int `url:"owner_id"`
	// Item identifier
	ItemID int `url:"item_id"`
}

NewsfeedIgnoreItemParams are params for Newsfeed.IgnoreItem

type NewsfeedSaveListParams

type NewsfeedSaveListParams struct {
	// numeric list identifier (if not sent, will be set automatically).
	ListID int `url:"list_id,omitempty"`
	// list name.
	Title string `url:"title"`
	// users and communities identifiers to be added to the list. Community identifiers must be negative numbers.
	SourceIDs CSVIntSlice `url:"source_ids,omitempty"`
	// reposts display on and off ('1' is for off).
	NoReposts bool `url:"no_reposts,omitempty"`
}

NewsfeedSaveListParams are params for Newsfeed.SaveList

type NewsfeedSaveListResponse

type NewsfeedSaveListResponse int

NewsfeedSaveListResponse is response for Newsfeed.SaveList List ID

type NewsfeedSearchParams

type NewsfeedSearchParams struct {
	// Search query string (e.g., 'New Year').
	Q string `url:"q,omitempty"`
	// '1' — to return additional information about the user or community that placed the post.
	Extended bool `url:"extended,omitempty"`
	// Number of posts to return.
	Count int `url:"count,omitempty"`
	// Geographical latitude point (in degrees, -90 to 90) within which to search.
	Latitude float32 `url:"latitude,omitempty"`
	// Geographical longitude point (in degrees, -180 to 180) within which to search.
	Longitude float32 `url:"longitude,omitempty"`
	// Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a news item to return. By default, the current time.
	EndTime   int    `url:"end_time,omitempty"`
	StartFrom string `url:"start_from,omitempty"`
	// Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
	Fields CSVStringSlice `url:"fields,omitempty"`
}

NewsfeedSearchParams are params for Newsfeed.Search

type NewsfeedSearchResponse

type NewsfeedSearchResponse interface {
	// contains filtered or unexported methods
}

NewsfeedSearchResponse is response for Newsfeed.Search Either NewsfeedSearchResponseNormal or NewsfeedSearchResponseExtended, depending on Extended flag

type NewsfeedSearchResponseExtended

type NewsfeedSearchResponseExtended struct {
	Items    []vk.Post  `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

NewsfeedSearchResponseExtended is extended version of NewsfeedSearchResponse

type NewsfeedSearchResponseNormal

type NewsfeedSearchResponseNormal struct {
	Items            []vk.Post `json:"items,omitempty"`
	SuggestedQueries []string  `json:"suggested_queries,omitempty"`
}

NewsfeedSearchResponseNormal is non-extended version of NewsfeedSearchResponse

type NewsfeedUnignoreItemParams

type NewsfeedUnignoreItemParams struct {
	// Item type. Possible values: *'wall' – post on the wall,, *'tag' – tag on a photo,, *'profilephoto' – profile photo,, *'video' – video,, *'audio' – audio.
	Type string `url:"type"`
	// Item owner's identifier (user or community), "Note that community id must be negative. 'owner_id=1' – user , 'owner_id=-1' – community "
	OwnerID int `url:"owner_id"`
	// Item identifier
	ItemID int `url:"item_id"`
}

NewsfeedUnignoreItemParams are params for Newsfeed.UnignoreItem

type NewsfeedUnsubscribeParams

type NewsfeedUnsubscribeParams struct {
	// Type of object from which to unsubscribe: 'note' — note, 'photo' — photo, 'post' — post on user wall or community wall, 'topic' — topic, 'video' — video
	Type string `url:"type"`
	// Object owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Object ID.
	ItemID int `url:"item_id"`
}

NewsfeedUnsubscribeParams are params for Newsfeed.Unsubscribe

type Notes

type Notes struct {
	API vk.API
}

Notes implements VK API namespace `notes`

func (Notes) Add

func (v Notes) Add(params NotesAddParams) (NotesAddResponse, error)

Add Creates a new note for the current user.

func (Notes) CreateComment

CreateComment Adds a new comment on a note.

func (Notes) Delete

func (v Notes) Delete(params NotesDeleteParams) (bool, error)

Delete Deletes a note of the current user.

func (Notes) DeleteComment

func (v Notes) DeleteComment(params NotesDeleteCommentParams) (bool, error)

DeleteComment Deletes a comment on a note.

func (Notes) Edit

func (v Notes) Edit(params NotesEditParams) (bool, error)

Edit Edits a note of the current user.

func (Notes) EditComment

func (v Notes) EditComment(params NotesEditCommentParams) (bool, error)

EditComment Edits a comment on a note.

func (Notes) Get

func (v Notes) Get(params NotesGetParams) (*NotesGetResponse, error)

Get Returns a list of notes created by a user.

func (Notes) GetByID

func (v Notes) GetByID(params NotesGetByIDParams) (*NotesGetByIDResponse, error)

GetByID Returns a note by its ID.

func (Notes) GetComments

func (v Notes) GetComments(params NotesGetCommentsParams) (*NotesGetCommentsResponse, error)

GetComments Returns a list of comments on a note.

func (Notes) RestoreComment

func (v Notes) RestoreComment(params NotesRestoreCommentParams) (bool, error)

RestoreComment Restores a deleted comment on a note.

type NotesAddParams

type NotesAddParams struct {
	// Note title.
	Title string `url:"title"`
	// Note text.
	Text           string         `url:"text"`
	PrivacyView    CSVStringSlice `url:"privacy_view,omitempty"`
	PrivacyComment CSVStringSlice `url:"privacy_comment,omitempty"`
}

NotesAddParams are params for Notes.Add

type NotesAddResponse

type NotesAddResponse int

NotesAddResponse is response for Notes.Add Note ID

type NotesCreateCommentParams

type NotesCreateCommentParams struct {
	// Note ID.
	NoteID int `url:"note_id"`
	// Note owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the user to whom the reply is addressed (if the comment is a reply to another comment).
	ReplyTo int `url:"reply_to,omitempty"`
	// Comment text.
	Message string `url:"message"`
	GUID    string `url:"guid,omitempty"`
}

NotesCreateCommentParams are params for Notes.CreateComment

type NotesCreateCommentResponse

type NotesCreateCommentResponse int

NotesCreateCommentResponse is response for Notes.CreateComment Comment ID

type NotesDeleteCommentParams

type NotesDeleteCommentParams struct {
	// Comment ID.
	CommentID int `url:"comment_id"`
	// Note owner ID.
	OwnerID int `url:"owner_id,omitempty"`
}

NotesDeleteCommentParams are params for Notes.DeleteComment

type NotesDeleteParams

type NotesDeleteParams struct {
	// Note ID.
	NoteID int `url:"note_id"`
}

NotesDeleteParams are params for Notes.Delete

type NotesEditCommentParams

type NotesEditCommentParams struct {
	// Comment ID.
	CommentID int `url:"comment_id"`
	// Note owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// New comment text.
	Message string `url:"message"`
}

NotesEditCommentParams are params for Notes.EditComment

type NotesEditParams

type NotesEditParams struct {
	// Note ID.
	NoteID int `url:"note_id"`
	// Note title.
	Title string `url:"title"`
	// Note text.
	Text           string         `url:"text"`
	PrivacyView    CSVStringSlice `url:"privacy_view,omitempty"`
	PrivacyComment CSVStringSlice `url:"privacy_comment,omitempty"`
}

NotesEditParams are params for Notes.Edit

type NotesGetByIDParams

type NotesGetByIDParams struct {
	// Note ID.
	NoteID int `url:"note_id"`
	// Note owner ID.
	OwnerID  int  `url:"owner_id,omitempty"`
	NeedWiki bool `url:"need_wiki,omitempty"`
}

NotesGetByIDParams are params for Notes.GetByID

type NotesGetByIDResponse

type NotesGetByIDResponse vk.Note

NotesGetByIDResponse is response for Notes.GetByID

type NotesGetCommentsParams

type NotesGetCommentsParams struct {
	// Note ID.
	NoteID int `url:"note_id"`
	// Note owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	Sort    int `url:"sort,omitempty"`
	Offset  int `url:"offset,omitempty"`
	// Number of comments to return.
	Count int `url:"count,omitempty"`
}

NotesGetCommentsParams are params for Notes.GetComments

type NotesGetCommentsResponse

type NotesGetCommentsResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

NotesGetCommentsResponse is response for Notes.GetComments

type NotesGetParams

type NotesGetParams struct {
	// Note IDs.
	NoteIDs CSVIntSlice `url:"note_ids,omitempty"`
	// Note owner ID.
	UserID int `url:"user_id,omitempty"`
	Offset int `url:"offset,omitempty"`
	// Number of notes to return.
	Count int `url:"count,omitempty"`
	Sort  int `url:"sort,omitempty"`
}

NotesGetParams are params for Notes.Get

type NotesGetResponse

type NotesGetResponse struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Note `json:"items,omitempty"`
}

NotesGetResponse is response for Notes.Get

type NotesRestoreCommentParams

type NotesRestoreCommentParams struct {
	// Comment ID.
	CommentID int `url:"comment_id"`
	// Note owner ID.
	OwnerID int `url:"owner_id,omitempty"`
}

NotesRestoreCommentParams are params for Notes.RestoreComment

type Notifications

type Notifications struct {
	API vk.API
}

Notifications implements VK API namespace `notifications`

func (Notifications) Get

Get Returns a list of notifications about other users' feedback to the current user's wall posts.

func (Notifications) MarkAsViewed

func (v Notifications) MarkAsViewed() (bool, error)

MarkAsViewed Resets the counter of new notifications about other users' feedback to the current user's wall posts.

type NotificationsGetParams

type NotificationsGetParams struct {
	// Number of notifications to return.
	Count     int    `url:"count,omitempty"`
	StartFrom string `url:"start_from,omitempty"`
	// Type of notifications to return: 'wall' — wall posts, 'mentions' — mentions in wall posts, comments, or topics, 'comments' — comments to wall posts, photos, and videos, 'likes' — likes, 'reposted' — wall posts that are copied from the current user's wall, 'followers' — new followers, 'friends' — accepted friend requests
	Filters CSVStringSlice `url:"filters,omitempty"`
	// Earliest timestamp (in Unix time) of a notification to return. By default, 24 hours ago.
	StartTime int `url:"start_time,omitempty"`
	// Latest timestamp (in Unix time) of a notification to return. By default, the current time.
	EndTime int `url:"end_time,omitempty"`
}

NotificationsGetParams are params for Notifications.Get

type NotificationsGetResponse

type NotificationsGetResponse struct {
	// Total number
	Count    int           `json:"count,omitempty"`
	Items    []genTODOType `json:"items,omitempty"`
	Profiles []vk.User     `json:"profiles,omitempty"`
	Groups   []vk.Group    `json:"groups,omitempty"`
	// Time when user has been checked notifications last time
	LastViewed int `json:"last_viewed,omitempty"`
}

NotificationsGetResponse is response for Notifications.Get

type Orders

type Orders struct {
	API vk.API
}

Orders implements VK API namespace `orders`

func (Orders) ChangeState

ChangeState Changes order status.

func (Orders) Get

func (v Orders) Get(params OrdersGetParams) (OrdersGetResponse, error)

Get Returns a list of orders.

func (Orders) GetAmount

GetAmount does orders.getAmount

func (Orders) GetByID

GetByID Returns information about orders by their IDs.

type OrdersChangeStateParams

type OrdersChangeStateParams struct {
	// order ID.
	OrderID int `url:"order_id"`
	// action to be done with the order. Available actions: *cancel — to cancel unconfirmed order. *charge — to confirm unconfirmed order. Applies only if processing of [vk.com/dev/payments_status|order_change_state] notification failed. *refund — to cancel confirmed order.
	Action string `url:"action"`
	// internal ID of the order in the application.
	AppOrderID int `url:"app_order_id,omitempty"`
	// if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.
	TestMode bool `url:"test_mode,omitempty"`
}

OrdersChangeStateParams are params for Orders.ChangeState

type OrdersChangeStateResponse

type OrdersChangeStateResponse string

OrdersChangeStateResponse is response for Orders.ChangeState New state

type OrdersGetAmountParams

type OrdersGetAmountParams struct {
	UserID int            `url:"user_id"`
	Votes  CSVStringSlice `url:"votes"`
}

OrdersGetAmountParams are params for Orders.GetAmount

type OrdersGetAmountResponse

type OrdersGetAmountResponse struct {
	Amounts []struct {
		// Votes number
		Votes string `json:"votes,omitempty"`
		// Votes amount in user's currency
		Amount int `json:"amount,omitempty"`
		// Amount description
		Description string `json:"description,omitempty"`
	} `json:"amounts,omitempty"`
	// Currency name
	Currency string `json:"currency,omitempty"`
}

OrdersGetAmountResponse is response for Orders.GetAmount

type OrdersGetByIDParams

type OrdersGetByIDParams struct {
	// order ID.
	OrderID int `url:"order_id,omitempty"`
	// order IDs (when information about several orders is requested).
	OrderIDs CSVIntSlice `url:"order_ids,omitempty"`
	// if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.
	TestMode bool `url:"test_mode,omitempty"`
}

OrdersGetByIDParams are params for Orders.GetByID

type OrdersGetByIDResponse

type OrdersGetByIDResponse []struct {
	// Order ID
	ID int `json:"id,omitempty"`
	// App order ID
	AppOrderID int `json:"app_order_id,omitempty"`
	// Order status
	Status string `json:"status,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
	// Receiver ID
	ReceiverID int `json:"receiver_id,omitempty"`
	// Order item
	Item string `json:"item,omitempty"`
	// Amount
	Amount int `json:"amount,omitempty"`
	// Date of creation in Unixtime
	Date int `json:"date,omitempty"`
	// Transaction ID
	TransactionID int `json:"transaction_id,omitempty"`
	// Cancel transaction ID
	CancelTransactionID int `json:"cancel_transaction_id,omitempty"`
}

OrdersGetByIDResponse is response for Orders.GetByID

type OrdersGetParams

type OrdersGetParams struct {
	Offset int `url:"offset,omitempty"`
	// number of returned orders.
	Count int `url:"count,omitempty"`
	// if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.
	TestMode bool `url:"test_mode,omitempty"`
}

OrdersGetParams are params for Orders.Get

type OrdersGetResponse

type OrdersGetResponse []struct {
	// Order ID
	ID int `json:"id,omitempty"`
	// App order ID
	AppOrderID int `json:"app_order_id,omitempty"`
	// Order status
	Status string `json:"status,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
	// Receiver ID
	ReceiverID int `json:"receiver_id,omitempty"`
	// Order item
	Item string `json:"item,omitempty"`
	// Amount
	Amount int `json:"amount,omitempty"`
	// Date of creation in Unixtime
	Date int `json:"date,omitempty"`
	// Transaction ID
	TransactionID int `json:"transaction_id,omitempty"`
	// Cancel transaction ID
	CancelTransactionID int `json:"cancel_transaction_id,omitempty"`
}

OrdersGetResponse is response for Orders.Get

type Pages

type Pages struct {
	API vk.API
}

Pages implements VK API namespace `pages`

func (Pages) ClearCache

func (v Pages) ClearCache(params PagesClearCacheParams) (bool, error)

ClearCache Allows to clear the cache of particular 'external' pages which may be attached to VK posts.

func (Pages) Get

func (v Pages) Get(params PagesGetParams) (*PagesGetResponse, error)

Get Returns information about a wiki page.

func (Pages) GetHistory

func (v Pages) GetHistory(params PagesGetHistoryParams) (PagesGetHistoryResponse, error)

GetHistory Returns a list of all previous versions of a wiki page.

func (Pages) GetTitles

func (v Pages) GetTitles(params PagesGetTitlesParams) (PagesGetTitlesResponse, error)

GetTitles Returns a list of wiki pages in a group.

func (Pages) GetVersion

func (v Pages) GetVersion(params PagesGetVersionParams) (*PagesGetVersionResponse, error)

GetVersion Returns the text of one of the previous versions of a wiki page.

func (Pages) ParseWiki

func (v Pages) ParseWiki(params PagesParseWikiParams) (PagesParseWikiResponse, error)

ParseWiki Returns HTML representation of the wiki markup.

func (Pages) Save

func (v Pages) Save(params PagesSaveParams) (PagesSaveResponse, error)

Save Saves the text of a wiki page.

func (Pages) SaveAccess

func (v Pages) SaveAccess(params PagesSaveAccessParams) (PagesSaveAccessResponse, error)

SaveAccess Saves modified read and edit access settings for a wiki page.

type PagesClearCacheParams

type PagesClearCacheParams struct {
	// Address of the page where you need to refesh the cached version
	URL string `url:"url"`
}

PagesClearCacheParams are params for Pages.ClearCache

type PagesGetHistoryParams

type PagesGetHistoryParams struct {
	// Wiki page ID.
	PageID int `url:"page_id"`
	// ID of the community that owns the wiki page.
	GroupID int `url:"group_id,omitempty"`
	UserID  int `url:"user_id,omitempty"`
}

PagesGetHistoryParams are params for Pages.GetHistory

type PagesGetHistoryResponse

type PagesGetHistoryResponse []struct {
	// Version ID
	ID int `json:"id,omitempty"`
	// Page size in bytes
	Length int `json:"length,omitempty"`
	// Date when the page has been edited in Unixtime
	Edited int `json:"edited,omitempty"`
	// Last editor ID
	EditorID int `json:"editor_id,omitempty"`
	// Last editor name
	EditorName string `json:"editor_name,omitempty"`
}

PagesGetHistoryResponse is response for Pages.GetHistory

type PagesGetParams

type PagesGetParams struct {
	// Page owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Wiki page ID.
	PageID int `url:"page_id,omitempty"`
	// '1' — to return information about a global wiki page
	Global bool `url:"global,omitempty"`
	// '1' — resulting wiki page is a preview for the attached link
	SitePreview bool `url:"site_preview,omitempty"`
	// Wiki page title.
	Title      string `url:"title,omitempty"`
	NeedSource bool   `url:"need_source,omitempty"`
	// '1' — to return the page as HTML,
	NeedHTML bool `url:"need_html,omitempty"`
}

PagesGetParams are params for Pages.Get

type PagesGetResponse

type PagesGetResponse vk.Page

PagesGetResponse is response for Pages.Get

type PagesGetTitlesParams

type PagesGetTitlesParams struct {
	// ID of the community that owns the wiki page.
	GroupID int `url:"group_id,omitempty"`
}

PagesGetTitlesParams are params for Pages.GetTitles

type PagesGetTitlesResponse

type PagesGetTitlesResponse []vk.Page

PagesGetTitlesResponse is response for Pages.GetTitles

type PagesGetVersionParams

type PagesGetVersionParams struct {
	VersionID int `url:"version_id"`
	// ID of the community that owns the wiki page.
	GroupID int `url:"group_id,omitempty"`
	UserID  int `url:"user_id,omitempty"`
	// '1' — to return the page as HTML
	NeedHTML bool `url:"need_html,omitempty"`
}

PagesGetVersionParams are params for Pages.GetVersion

type PagesGetVersionResponse

type PagesGetVersionResponse vk.Page

PagesGetVersionResponse is response for Pages.GetVersion

type PagesParseWikiParams

type PagesParseWikiParams struct {
	// Text of the wiki page.
	Text string `url:"text"`
	// ID of the group in the context of which this markup is interpreted.
	GroupID int `url:"group_id,omitempty"`
}

PagesParseWikiParams are params for Pages.ParseWiki

type PagesParseWikiResponse

type PagesParseWikiResponse string

PagesParseWikiResponse is response for Pages.ParseWiki HTML source

type PagesSaveAccessParams

type PagesSaveAccessParams struct {
	// Wiki page ID.
	PageID int `url:"page_id"`
	// ID of the community that owns the wiki page.
	GroupID int `url:"group_id,omitempty"`
	UserID  int `url:"user_id,omitempty"`
	// Who can view the wiki page: '1' — only community members, '2' — all users can view the page, '0' — only community managers
	View int `url:"view,omitempty"`
	// Who can edit the wiki page: '1' — only community members, '2' — all users can edit the page, '0' — only community managers
	Edit int `url:"edit,omitempty"`
}

PagesSaveAccessParams are params for Pages.SaveAccess

type PagesSaveAccessResponse

type PagesSaveAccessResponse int

PagesSaveAccessResponse is response for Pages.SaveAccess Page ID

type PagesSaveParams

type PagesSaveParams struct {
	// Text of the wiki page in wiki-format.
	Text string `url:"text,omitempty"`
	// Wiki page ID. The 'title' parameter can be passed instead of 'pid'.
	PageID int `url:"page_id,omitempty"`
	// ID of the community that owns the wiki page.
	GroupID int `url:"group_id,omitempty"`
	// User ID
	UserID int `url:"user_id,omitempty"`
	// Wiki page title.
	Title string `url:"title,omitempty"`
}

PagesSaveParams are params for Pages.Save

type PagesSaveResponse

type PagesSaveResponse int

PagesSaveResponse is response for Pages.Save Page ID

type Photos

type Photos struct {
	API vk.API
}

Photos implements VK API namespace `photos`

func (Photos) ConfirmTag

func (v Photos) ConfirmTag(params PhotosConfirmTagParams) (bool, error)

ConfirmTag Confirms a tag on a photo.

func (Photos) Copy

func (v Photos) Copy(params PhotosCopyParams) (PhotosCopyResponse, error)

Copy Allows to copy a photo to the "Saved photos" album

func (Photos) CreateAlbum

CreateAlbum Creates an empty photo album.

func (Photos) CreateComment

CreateComment Adds a new comment on the photo.

func (Photos) Delete

func (v Photos) Delete(params PhotosDeleteParams) (bool, error)

Delete Deletes a photo.

func (Photos) DeleteAlbum

func (v Photos) DeleteAlbum(params PhotosDeleteAlbumParams) (bool, error)

DeleteAlbum Deletes a photo album belonging to the current user.

func (Photos) DeleteComment

func (v Photos) DeleteComment(params PhotosDeleteCommentParams) (bool, error)

DeleteComment Deletes a comment on the photo.

func (Photos) Edit

func (v Photos) Edit(params PhotosEditParams) (bool, error)

Edit Edits the caption of a photo.

func (Photos) EditAlbum

func (v Photos) EditAlbum(params PhotosEditAlbumParams) (bool, error)

EditAlbum Edits information about a photo album.

func (Photos) EditComment

func (v Photos) EditComment(params PhotosEditCommentParams) (bool, error)

EditComment Edits a comment on a photo.

func (Photos) Get

func (v Photos) Get(params PhotosGetParams) (PhotosGetResponse, error)

Get Returns a list of a user's or community's photos.

func (Photos) GetAlbums

GetAlbums Returns a list of a user's or community's photo albums.

func (Photos) GetAlbumsCount

GetAlbumsCount Returns the number of photo albums belonging to a user or community.

func (Photos) GetAll

GetAll Returns a list of photos belonging to a user or community, in reverse chronological order.

func (Photos) GetAllComments

GetAllComments Returns a list of comments on a specific photo album or all albums of the user sorted in reverse chronological order.

func (Photos) GetByID

GetByID Returns information about photos by their IDs.

func (Photos) GetChatUploadServer

GetChatUploadServer Returns an upload link for chat cover pictures.

func (Photos) GetComments

GetComments Returns a list of comments on a photo.

func (Photos) GetMarketAlbumUploadServer

GetMarketAlbumUploadServer Returns the server address for market album photo upload.

func (Photos) GetMarketUploadServer

GetMarketUploadServer Returns the server address for market photo upload.

func (Photos) GetMessagesUploadServer

GetMessagesUploadServer Returns the server address for photo upload in a private message for a user.

func (Photos) GetNewTags

GetNewTags Returns a list of photos with tags that have not been viewed.

func (Photos) GetOwnerCoverPhotoUploadServer

GetOwnerCoverPhotoUploadServer Returns the server address for owner cover upload.

func (Photos) GetOwnerPhotoUploadServer

GetOwnerPhotoUploadServer Returns an upload server address for a profile or community photo.

func (Photos) GetTags

GetTags Returns a list of tags on a photo.

func (Photos) GetUploadServer

GetUploadServer Returns the server address for photo upload.

func (Photos) GetUserPhotos

GetUserPhotos Returns a list of photos in which a user is tagged.

func (Photos) GetWallUploadServer

GetWallUploadServer Returns the server address for photo upload onto a user's wall.

func (Photos) MakeCover

func (v Photos) MakeCover(params PhotosMakeCoverParams) (bool, error)

MakeCover Makes a photo into an album cover.

func (Photos) Move

func (v Photos) Move(params PhotosMoveParams) (bool, error)

Move Moves a photo from one album to another.

func (Photos) PutTag

PutTag Adds a tag on the photo.

func (Photos) RemoveTag

func (v Photos) RemoveTag(params PhotosRemoveTagParams) (bool, error)

RemoveTag Removes a tag from a photo.

func (Photos) ReorderAlbums

func (v Photos) ReorderAlbums(params PhotosReorderAlbumsParams) (bool, error)

ReorderAlbums Reorders the album in the list of user albums.

func (Photos) ReorderPhotos

func (v Photos) ReorderPhotos(params PhotosReorderPhotosParams) (bool, error)

ReorderPhotos Reorders the photo in the list of photos of the user album.

func (Photos) Report

func (v Photos) Report(params PhotosReportParams) (bool, error)

Report Reports (submits a complaint about) a photo.

func (Photos) ReportComment

func (v Photos) ReportComment(params PhotosReportCommentParams) (bool, error)

ReportComment Reports (submits a complaint about) a comment on a photo.

func (Photos) Restore

func (v Photos) Restore(params PhotosRestoreParams) (bool, error)

Restore Restores a deleted photo.

func (Photos) RestoreComment

func (v Photos) RestoreComment(params PhotosRestoreCommentParams) (bool, error)

RestoreComment Restores a deleted comment on a photo.

func (Photos) Save

func (v Photos) Save(params PhotosSaveParams) (PhotosSaveResponse, error)

Save Saves photos after successful uploading.

func (Photos) SaveMarketAlbumPhoto

SaveMarketAlbumPhoto Saves market album photos after successful uploading.

func (Photos) SaveMarketPhoto

SaveMarketPhoto Saves market photos after successful uploading.

func (Photos) SaveMessagesPhoto

SaveMessagesPhoto Saves a photo after being successfully uploaded. URL obtained with [vk.com/dev/photos.getMessagesUploadServer|photos.getMessagesUploadServer] method.

func (Photos) SaveOwnerCoverPhoto

SaveOwnerCoverPhoto Saves cover photo after successful uploading.

func (Photos) SaveOwnerPhoto

SaveOwnerPhoto Saves a profile or community photo. Upload URL can be got with the [vk.com/dev/photos.getOwnerPhotoUploadServer|photos.getOwnerPhotoUploadServer] method.

func (Photos) SaveWallPhoto

SaveWallPhoto Saves a photo to a user's or community's wall after being uploaded.

func (Photos) Search

func (v Photos) Search(params PhotosSearchParams) (*PhotosSearchResponse, error)

Search Returns a list of photos.

type PhotosConfirmTagParams

type PhotosConfirmTagParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID string `url:"photo_id"`
	// Tag ID.
	TagID int `url:"tag_id"`
}

PhotosConfirmTagParams are params for Photos.ConfirmTag

type PhotosCopyParams

type PhotosCopyParams struct {
	// photo's owner ID
	OwnerID int `url:"owner_id"`
	// photo ID
	PhotoID int `url:"photo_id"`
	// for private photos
	AccessKey string `url:"access_key,omitempty"`
}

PhotosCopyParams are params for Photos.Copy

type PhotosCopyResponse

type PhotosCopyResponse int

PhotosCopyResponse is response for Photos.Copy Photo ID

type PhotosCreateAlbumParams

type PhotosCreateAlbumParams struct {
	// Album title.
	Title string `url:"title"`
	// ID of the community in which the album will be created.
	GroupID int `url:"group_id,omitempty"`
	// Album description.
	Description        string         `url:"description,omitempty"`
	PrivacyView        CSVStringSlice `url:"privacy_view,omitempty"`
	PrivacyComment     CSVStringSlice `url:"privacy_comment,omitempty"`
	UploadByAdminsOnly bool           `url:"upload_by_admins_only,omitempty"`
	CommentsDisabled   bool           `url:"comments_disabled,omitempty"`
}

PhotosCreateAlbumParams are params for Photos.CreateAlbum

type PhotosCreateAlbumResponse

type PhotosCreateAlbumResponse genTODOType /* objects.json#/definitions/photos_photo_album_full */

PhotosCreateAlbumResponse is response for Photos.CreateAlbum

type PhotosCreateCommentParams

type PhotosCreateCommentParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// Comment text.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — Media attachment owner ID. '<media_id>' — Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// '1' — to post a comment from the community
	FromGroup      bool   `url:"from_group,omitempty"`
	ReplyToComment int    `url:"reply_to_comment,omitempty"`
	StickerID      int    `url:"sticker_id,omitempty"`
	AccessKey      string `url:"access_key,omitempty"`
	GUID           string `url:"guid,omitempty"`
}

PhotosCreateCommentParams are params for Photos.CreateComment

type PhotosCreateCommentResponse

type PhotosCreateCommentResponse int

PhotosCreateCommentResponse is response for Photos.CreateComment Created comment ID

type PhotosDeleteAlbumParams

type PhotosDeleteAlbumParams struct {
	// Album ID.
	AlbumID int `url:"album_id"`
	// ID of the community that owns the album.
	GroupID int `url:"group_id,omitempty"`
}

PhotosDeleteAlbumParams are params for Photos.DeleteAlbum

type PhotosDeleteCommentParams

type PhotosDeleteCommentParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
}

PhotosDeleteCommentParams are params for Photos.DeleteComment

type PhotosDeleteParams

type PhotosDeleteParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
}

PhotosDeleteParams are params for Photos.Delete

type PhotosEditAlbumParams

type PhotosEditAlbumParams struct {
	// ID of the photo album to be edited.
	AlbumID int `url:"album_id"`
	// New album title.
	Title string `url:"title,omitempty"`
	// New album description.
	Description string `url:"description,omitempty"`
	// ID of the user or community that owns the album.
	OwnerID            int            `url:"owner_id,omitempty"`
	PrivacyView        CSVStringSlice `url:"privacy_view,omitempty"`
	PrivacyComment     CSVStringSlice `url:"privacy_comment,omitempty"`
	UploadByAdminsOnly bool           `url:"upload_by_admins_only,omitempty"`
	CommentsDisabled   bool           `url:"comments_disabled,omitempty"`
}

PhotosEditAlbumParams are params for Photos.EditAlbum

type PhotosEditCommentParams

type PhotosEditCommentParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// New text of the comment.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — Media attachment owner ID. '<media_id>' — Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

PhotosEditCommentParams are params for Photos.EditComment

type PhotosEditParams

type PhotosEditParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.
	Caption      string  `url:"caption,omitempty"`
	Latitude     float32 `url:"latitude,omitempty"`
	Longitude    float32 `url:"longitude,omitempty"`
	PlaceStr     string  `url:"place_str,omitempty"`
	FoursquareID string  `url:"foursquare_id,omitempty"`
	DeletePlace  bool    `url:"delete_place,omitempty"`
}

PhotosEditParams are params for Photos.Edit

type PhotosGetAlbumsCountParams

type PhotosGetAlbumsCountParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Community ID.
	GroupID int `url:"group_id,omitempty"`
}

PhotosGetAlbumsCountParams are params for Photos.GetAlbumsCount

type PhotosGetAlbumsCountResponse

type PhotosGetAlbumsCountResponse int

PhotosGetAlbumsCountResponse is response for Photos.GetAlbumsCount Albums number

type PhotosGetAlbumsParams

type PhotosGetAlbumsParams struct {
	// ID of the user or community that owns the albums.
	OwnerID int `url:"owner_id,omitempty"`
	// Album IDs.
	AlbumIDs CSVIntSlice `url:"album_ids,omitempty"`
	// Offset needed to return a specific subset of albums.
	Offset int `url:"offset,omitempty"`
	// Number of albums to return.
	Count int `url:"count,omitempty"`
	// '1' — to return system albums with negative IDs
	NeedSystem bool `url:"need_system,omitempty"`
	// '1' — to return an additional 'thumb_src' field, '0' — (default)
	NeedCovers bool `url:"need_covers,omitempty"`
	// '1' — to return photo sizes in a
	PhotoSizes bool `url:"photo_sizes,omitempty"`
}

PhotosGetAlbumsParams are params for Photos.GetAlbums

type PhotosGetAlbumsResponse

type PhotosGetAlbumsResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

PhotosGetAlbumsResponse is response for Photos.GetAlbums

type PhotosGetAllCommentsParams

type PhotosGetAllCommentsParams struct {
	// ID of the user or community that owns the album(s).
	OwnerID int `url:"owner_id,omitempty"`
	// Album ID. If the parameter is not set, comments on all of the user's albums will be returned.
	AlbumID int `url:"album_id,omitempty"`
	// '1' — to return an additional 'likes' field, '0' — (default)
	NeedLikes bool `url:"need_likes,omitempty"`
	// Offset needed to return a specific subset of comments. By default, '0'.
	Offset int `url:"offset,omitempty"`
	// Number of comments to return. By default, '20'. Maximum value, '100'.
	Count int `url:"count,omitempty"`
}

PhotosGetAllCommentsParams are params for Photos.GetAllComments

type PhotosGetAllCommentsResponse

type PhotosGetAllCommentsResponse struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Comment `json:"items,omitempty"`
}

PhotosGetAllCommentsResponse is response for Photos.GetAllComments

type PhotosGetAllParams

type PhotosGetAllParams struct {
	// ID of a user or community that owns the photos. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// '1' — to return detailed information about photos
	Extended bool `url:"extended,omitempty"`
	// Offset needed to return a specific subset of photos. By default, '0'.
	Offset int `url:"offset,omitempty"`
	// Number of photos to return.
	Count int `url:"count,omitempty"`
	// '1' – to return image sizes in [vk.com/dev/photo_sizes|special format].
	PhotoSizes bool `url:"photo_sizes,omitempty"`
	// '1' – to return photos only from standard albums, '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default)
	NoServiceAlbums bool `url:"no_service_albums,omitempty"`
	// '1' – to show information about photos being hidden from the block above the wall.
	NeedHidden bool `url:"need_hidden,omitempty"`
	// '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.
	SkipHidden bool `url:"skip_hidden,omitempty"`
}

PhotosGetAllParams are params for Photos.GetAll

type PhotosGetAllResponse

type PhotosGetAllResponse interface {
	// contains filtered or unexported methods
}

PhotosGetAllResponse is response for Photos.GetAll Either PhotosGetAllResponseNormal or PhotosGetAllResponseExtended, depending on Extended flag

type PhotosGetAllResponseExtended

type PhotosGetAllResponseExtended struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
	// Information whether next page is presented
	More vk.BoolInt `json:"more,omitempty"`
}

PhotosGetAllResponseExtended is extended version of PhotosGetAllResponse

type PhotosGetAllResponseNormal

type PhotosGetAllResponseNormal struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
	// Information whether next page is presented
	More vk.BoolInt `json:"more,omitempty"`
}

PhotosGetAllResponseNormal is non-extended version of PhotosGetAllResponse

type PhotosGetByIDParams

type PhotosGetByIDParams struct {
	// IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs. To get information about a photo in the group album, you shall specify group ID instead of user ID. Example: "1_129207899,6492_135055734, , -20629724_271945303"
	Photos CSVStringSlice `url:"photos"`
	// '1' — to return additional fields, '0' — (default)
	Extended bool `url:"extended,omitempty"`
	// '1' — to return photo sizes in a
	PhotoSizes bool `url:"photo_sizes,omitempty"`
}

PhotosGetByIDParams are params for Photos.GetByID

type PhotosGetByIDResponse

type PhotosGetByIDResponse interface {
	// contains filtered or unexported methods
}

PhotosGetByIDResponse is response for Photos.GetByID Either PhotosGetByIDResponseNormal or PhotosGetByIDResponseExtended, depending on Extended flag

type PhotosGetByIDResponseExtended

type PhotosGetByIDResponseExtended []vk.Photo

PhotosGetByIDResponseExtended is extended version of PhotosGetByIDResponse

type PhotosGetByIDResponseNormal

type PhotosGetByIDResponseNormal []vk.Photo

PhotosGetByIDResponseNormal is non-extended version of PhotosGetByIDResponse

type PhotosGetChatUploadServerParams

type PhotosGetChatUploadServerParams struct {
	// ID of the chat for which you want to upload a cover photo.
	ChatID int `url:"chat_id"`
	CropX  int `url:"crop_x,omitempty"`
	CropY  int `url:"crop_y,omitempty"`
	// Width (in pixels) of the photo after cropping.
	CropWidth int `url:"crop_width,omitempty"`
}

PhotosGetChatUploadServerParams are params for Photos.GetChatUploadServer

type PhotosGetChatUploadServerResponse

type PhotosGetChatUploadServerResponse struct {
	// URL to upload photo
	UploadURL string `json:"upload_url,omitempty"`
	// Album ID
	AlbumID int `json:"album_id,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
}

PhotosGetChatUploadServerResponse is response for Photos.GetChatUploadServer

type PhotosGetCommentsParams

type PhotosGetCommentsParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// '1' — to return an additional 'likes' field, '0' — (default)
	NeedLikes      bool `url:"need_likes,omitempty"`
	StartCommentID int  `url:"start_comment_id,omitempty"`
	// Offset needed to return a specific subset of comments. By default, '0'.
	Offset int `url:"offset,omitempty"`
	// Number of comments to return.
	Count int `url:"count,omitempty"`
	// Sort order: 'asc' — old first, 'desc' — new first
	Sort      string         `url:"sort,omitempty"`
	AccessKey string         `url:"access_key,omitempty"`
	Extended  bool           `url:"extended,omitempty"`
	Fields    CSVStringSlice `url:"fields,omitempty"`
}

PhotosGetCommentsParams are params for Photos.GetComments

type PhotosGetCommentsResponse

type PhotosGetCommentsResponse interface {
	// contains filtered or unexported methods
}

PhotosGetCommentsResponse is response for Photos.GetComments Either PhotosGetCommentsResponseNormal or PhotosGetCommentsResponseExtended, depending on Extended flag

type PhotosGetCommentsResponseExtended

type PhotosGetCommentsResponseExtended struct {
	// Total number
	Count int `json:"count,omitempty"`
	// Real offset of the comments
	RealOffset int          `json:"real_offset,omitempty"`
	Items      []vk.Comment `json:"items,omitempty"`
	Profiles   []vk.User    `json:"profiles,omitempty"`
	Groups     []vk.Group   `json:"groups,omitempty"`
}

PhotosGetCommentsResponseExtended is extended version of PhotosGetCommentsResponse

type PhotosGetCommentsResponseNormal

type PhotosGetCommentsResponseNormal struct {
	// Total number
	Count int `json:"count,omitempty"`
	// Real offset of the comments
	RealOffset int          `json:"real_offset,omitempty"`
	Items      []vk.Comment `json:"items,omitempty"`
}

PhotosGetCommentsResponseNormal is non-extended version of PhotosGetCommentsResponse

type PhotosGetMarketAlbumUploadServerParams

type PhotosGetMarketAlbumUploadServerParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
}

PhotosGetMarketAlbumUploadServerParams are params for Photos.GetMarketAlbumUploadServer

type PhotosGetMarketAlbumUploadServerResponse

type PhotosGetMarketAlbumUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

PhotosGetMarketAlbumUploadServerResponse is response for Photos.GetMarketAlbumUploadServer

type PhotosGetMarketUploadServerParams

type PhotosGetMarketUploadServerParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// '1' if you want to upload the main item photo.
	MainPhoto bool `url:"main_photo,omitempty"`
	// X coordinate of the crop left upper corner.
	CropX int `url:"crop_x,omitempty"`
	// Y coordinate of the crop left upper corner.
	CropY int `url:"crop_y,omitempty"`
	// Width of the cropped photo in px.
	CropWidth int `url:"crop_width,omitempty"`
}

PhotosGetMarketUploadServerParams are params for Photos.GetMarketUploadServer

type PhotosGetMarketUploadServerResponse

type PhotosGetMarketUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

PhotosGetMarketUploadServerResponse is response for Photos.GetMarketUploadServer

type PhotosGetMessagesUploadServerParams

type PhotosGetMessagesUploadServerParams struct {
	// Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
	PeerID int `url:"peer_id,omitempty"`
}

PhotosGetMessagesUploadServerParams are params for Photos.GetMessagesUploadServer

type PhotosGetMessagesUploadServerResponse

type PhotosGetMessagesUploadServerResponse struct {
	// URL to upload photo
	UploadURL string `json:"upload_url,omitempty"`
	// Album ID
	AlbumID int `json:"album_id,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
}

PhotosGetMessagesUploadServerResponse is response for Photos.GetMessagesUploadServer

type PhotosGetNewTagsParams

type PhotosGetNewTagsParams struct {
	// Offset needed to return a specific subset of photos.
	Offset int `url:"offset,omitempty"`
	// Number of photos to return.
	Count int `url:"count,omitempty"`
}

PhotosGetNewTagsParams are params for Photos.GetNewTags

type PhotosGetNewTagsResponse

type PhotosGetNewTagsResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

PhotosGetNewTagsResponse is response for Photos.GetNewTags

type PhotosGetOwnerCoverPhotoUploadServerParams

type PhotosGetOwnerCoverPhotoUploadServerParams struct {
	// ID of community that owns the album (if the photo will be uploaded to a community album).
	GroupID int `url:"group_id"`
	// X coordinate of the left-upper corner
	CropX int `url:"crop_x,omitempty"`
	// Y coordinate of the left-upper corner
	CropY int `url:"crop_y,omitempty"`
	// X coordinate of the right-bottom corner
	CropX2 int `url:"crop_x2,omitempty"`
	// Y coordinate of the right-bottom corner
	CropY2 int `url:"crop_y2,omitempty"`
}

PhotosGetOwnerCoverPhotoUploadServerParams are params for Photos.GetOwnerCoverPhotoUploadServer

type PhotosGetOwnerCoverPhotoUploadServerResponse

type PhotosGetOwnerCoverPhotoUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

PhotosGetOwnerCoverPhotoUploadServerResponse is response for Photos.GetOwnerCoverPhotoUploadServer

type PhotosGetOwnerPhotoUploadServerParams

type PhotosGetOwnerPhotoUploadServerParams struct {
	// identifier of a community or current user. "Note that community id must be negative. 'owner_id=1' – user, 'owner_id=-1' – community, "
	OwnerID int `url:"owner_id,omitempty"`
}

PhotosGetOwnerPhotoUploadServerParams are params for Photos.GetOwnerPhotoUploadServer

type PhotosGetOwnerPhotoUploadServerResponse

type PhotosGetOwnerPhotoUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
}

PhotosGetOwnerPhotoUploadServerResponse is response for Photos.GetOwnerPhotoUploadServer

type PhotosGetParams

type PhotosGetParams struct {
	// ID of the user or community that owns the photos. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.
	AlbumID string `url:"album_id,omitempty"`
	// Photo IDs.
	PhotoIDs CSVStringSlice `url:"photo_ids,omitempty"`
	// Sort order: '1' — reverse chronological, '0' — chronological
	Rev bool `url:"rev,omitempty"`
	// '1' — to return additional 'likes', 'comments', and 'tags' fields, '0' — (default)
	Extended bool `url:"extended,omitempty"`
	// Type of feed obtained in 'feed' field of the method.
	FeedType string `url:"feed_type,omitempty"`
	// unixtime, that can be obtained with [vk.com/dev/newsfeed.get|newsfeed.get] method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.
	Feed int `url:"feed,omitempty"`
	// '1' — to return photo sizes in a [vk.com/dev/photo_sizes|special format]
	PhotoSizes bool `url:"photo_sizes,omitempty"`
	Offset     int  `url:"offset,omitempty"`
	Count      int  `url:"count,omitempty"`
}

PhotosGetParams are params for Photos.Get

type PhotosGetResponse

type PhotosGetResponse interface {
	// contains filtered or unexported methods
}

PhotosGetResponse is response for Photos.Get Either PhotosGetResponseNormal or PhotosGetResponseExtended, depending on Extended flag

type PhotosGetResponseExtended

type PhotosGetResponseExtended struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

PhotosGetResponseExtended is extended version of PhotosGetResponse

type PhotosGetResponseNormal

type PhotosGetResponseNormal struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

PhotosGetResponseNormal is non-extended version of PhotosGetResponse

type PhotosGetTagsParams

type PhotosGetTagsParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID   int    `url:"photo_id"`
	AccessKey string `url:"access_key,omitempty"`
}

PhotosGetTagsParams are params for Photos.GetTags

type PhotosGetTagsResponse

type PhotosGetTagsResponse []genTODOType /* objects.json#/definitions/photos_photo_tag */

PhotosGetTagsResponse is response for Photos.GetTags

type PhotosGetUploadServerParams

type PhotosGetUploadServerParams struct {
	// ID of community that owns the album (if the photo will be uploaded to a community album).
	GroupID int `url:"group_id,omitempty"`
	AlbumID int `url:"album_id,omitempty"`
}

PhotosGetUploadServerParams are params for Photos.GetUploadServer

type PhotosGetUploadServerResponse

type PhotosGetUploadServerResponse struct {
	// URL to upload photo
	UploadURL string `json:"upload_url,omitempty"`
	// Album ID
	AlbumID int `json:"album_id,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
}

PhotosGetUploadServerResponse is response for Photos.GetUploadServer

type PhotosGetUserPhotosParams

type PhotosGetUserPhotosParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Offset needed to return a specific subset of photos. By default, '0'.
	Offset int `url:"offset,omitempty"`
	// Number of photos to return. Maximum value is 1000.
	Count int `url:"count,omitempty"`
	// '1' — to return an additional 'likes' field, '0' — (default)
	Extended bool `url:"extended,omitempty"`
	// Sort order: '1' — by date the tag was added in ascending order, '0' — by date the tag was added in descending order
	Sort string `url:"sort,omitempty"`
}

PhotosGetUserPhotosParams are params for Photos.GetUserPhotos

type PhotosGetUserPhotosResponse

type PhotosGetUserPhotosResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

PhotosGetUserPhotosResponse is response for Photos.GetUserPhotos

type PhotosGetWallUploadServerParams

type PhotosGetWallUploadServerParams struct {
	// ID of community to whose wall the photo will be uploaded.
	GroupID int `url:"group_id,omitempty"`
}

PhotosGetWallUploadServerParams are params for Photos.GetWallUploadServer

type PhotosGetWallUploadServerResponse

type PhotosGetWallUploadServerResponse struct {
	// URL to upload photo
	UploadURL string `json:"upload_url,omitempty"`
	// Album ID
	AlbumID int `json:"album_id,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
}

PhotosGetWallUploadServerResponse is response for Photos.GetWallUploadServer

type PhotosMakeCoverParams

type PhotosMakeCoverParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// Album ID.
	AlbumID int `url:"album_id,omitempty"`
}

PhotosMakeCoverParams are params for Photos.MakeCover

type PhotosMoveParams

type PhotosMoveParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the album to which the photo will be moved.
	TargetAlbumID int `url:"target_album_id"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
}

PhotosMoveParams are params for Photos.Move

type PhotosPutTagParams

type PhotosPutTagParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// ID of the user to be tagged.
	UserID int `url:"user_id"`
	// Upper left-corner coordinate of the tagged area (as a percentage of the photo's width).
	X float32 `url:"x,omitempty"`
	// Upper left-corner coordinate of the tagged area (as a percentage of the photo's height).
	Y float32 `url:"y,omitempty"`
	// Lower right-corner coordinate of the tagged area (as a percentage of the photo's width).
	X2 float32 `url:"x2,omitempty"`
	// Lower right-corner coordinate of the tagged area (as a percentage of the photo's height).
	Y2 float32 `url:"y2,omitempty"`
}

PhotosPutTagParams are params for Photos.PutTag

type PhotosPutTagResponse

type PhotosPutTagResponse int

PhotosPutTagResponse is response for Photos.PutTag Created tag ID

type PhotosRemoveTagParams

type PhotosRemoveTagParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// Tag ID.
	TagID int `url:"tag_id"`
}

PhotosRemoveTagParams are params for Photos.RemoveTag

type PhotosReorderAlbumsParams

type PhotosReorderAlbumsParams struct {
	// ID of the user or community that owns the album.
	OwnerID int `url:"owner_id,omitempty"`
	// Album ID.
	AlbumID int `url:"album_id"`
	// ID of the album before which the album in question shall be placed.
	Before int `url:"before,omitempty"`
	// ID of the album after which the album in question shall be placed.
	After int `url:"after,omitempty"`
}

PhotosReorderAlbumsParams are params for Photos.ReorderAlbums

type PhotosReorderPhotosParams

type PhotosReorderPhotosParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// ID of the photo before which the photo in question shall be placed.
	Before int `url:"before,omitempty"`
	// ID of the photo after which the photo in question shall be placed.
	After int `url:"after,omitempty"`
}

PhotosReorderPhotosParams are params for Photos.ReorderPhotos

type PhotosReportCommentParams

type PhotosReportCommentParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id"`
	// ID of the comment being reported.
	CommentID int `url:"comment_id"`
	// Reason for the complaint: '0' – spam, '1' – child pornography, '2' – extremism, '3' – violence, '4' – drug propaganda, '5' – adult material, '6' – insult, abuse
	Reason int `url:"reason,omitempty"`
}

PhotosReportCommentParams are params for Photos.ReportComment

type PhotosReportParams

type PhotosReportParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
	// Reason for the complaint: '0' – spam, '1' – child pornography, '2' – extremism, '3' – violence, '4' – drug propaganda, '5' – adult material, '6' – insult, abuse
	Reason int `url:"reason,omitempty"`
}

PhotosReportParams are params for Photos.Report

type PhotosRestoreCommentParams

type PhotosRestoreCommentParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the deleted comment.
	CommentID int `url:"comment_id"`
}

PhotosRestoreCommentParams are params for Photos.RestoreComment

type PhotosRestoreParams

type PhotosRestoreParams struct {
	// ID of the user or community that owns the photo.
	OwnerID int `url:"owner_id,omitempty"`
	// Photo ID.
	PhotoID int `url:"photo_id"`
}

PhotosRestoreParams are params for Photos.Restore

type PhotosSaveMarketAlbumPhotoParams

type PhotosSaveMarketAlbumPhotoParams struct {
	// Community ID.
	GroupID int `url:"group_id"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Photo string `url:"photo"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Server int `url:"server"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Hash string `url:"hash"`
}

PhotosSaveMarketAlbumPhotoParams are params for Photos.SaveMarketAlbumPhoto

type PhotosSaveMarketAlbumPhotoResponse

type PhotosSaveMarketAlbumPhotoResponse []vk.Photo

PhotosSaveMarketAlbumPhotoResponse is response for Photos.SaveMarketAlbumPhoto

type PhotosSaveMarketPhotoParams

type PhotosSaveMarketPhotoParams struct {
	// Community ID.
	GroupID int `url:"group_id,omitempty"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Photo string `url:"photo"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Server int `url:"server"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Hash string `url:"hash"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	CropData string `url:"crop_data,omitempty"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	CropHash string `url:"crop_hash,omitempty"`
}

PhotosSaveMarketPhotoParams are params for Photos.SaveMarketPhoto

type PhotosSaveMarketPhotoResponse

type PhotosSaveMarketPhotoResponse []vk.Photo

PhotosSaveMarketPhotoResponse is response for Photos.SaveMarketPhoto

type PhotosSaveMessagesPhotoParams

type PhotosSaveMessagesPhotoParams struct {
	// Parameter returned when the photo is [vk.com/dev/upload_files|uploaded to the server].
	Photo  string `url:"photo"`
	Server int    `url:"server,omitempty"`
	Hash   string `url:"hash,omitempty"`
}

PhotosSaveMessagesPhotoParams are params for Photos.SaveMessagesPhoto

type PhotosSaveMessagesPhotoResponse

type PhotosSaveMessagesPhotoResponse []vk.Photo

PhotosSaveMessagesPhotoResponse is response for Photos.SaveMessagesPhoto

type PhotosSaveOwnerCoverPhotoParams

type PhotosSaveOwnerCoverPhotoParams struct {
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Hash string `url:"hash"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Photo string `url:"photo"`
}

PhotosSaveOwnerCoverPhotoParams are params for Photos.SaveOwnerCoverPhoto

type PhotosSaveOwnerCoverPhotoResponse

type PhotosSaveOwnerCoverPhotoResponse []vk.BaseImage

PhotosSaveOwnerCoverPhotoResponse is response for Photos.SaveOwnerCoverPhoto

type PhotosSaveOwnerPhotoParams

type PhotosSaveOwnerPhotoParams struct {
	// parameter returned after [vk.com/dev/upload_files|photo upload].
	Server string `url:"server,omitempty"`
	// parameter returned after [vk.com/dev/upload_files|photo upload].
	Hash string `url:"hash,omitempty"`
	// parameter returned after [vk.com/dev/upload_files|photo upload].
	Photo string `url:"photo,omitempty"`
}

PhotosSaveOwnerPhotoParams are params for Photos.SaveOwnerPhoto

type PhotosSaveOwnerPhotoResponse

type PhotosSaveOwnerPhotoResponse struct {
	// Parameter for saveProfilePhoto method
	PhotoHash string `json:"photo_hash,omitempty"`
	// Uploaded image url
	PhotoSrc string `json:"photo_src,omitempty"`
}

PhotosSaveOwnerPhotoResponse is response for Photos.SaveOwnerPhoto

type PhotosSaveParams

type PhotosSaveParams struct {
	// ID of the album to save photos to.
	AlbumID int `url:"album_id,omitempty"`
	// ID of the community to save photos to.
	GroupID int `url:"group_id,omitempty"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Server int `url:"server,omitempty"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	PhotosList string `url:"photos_list,omitempty"`
	// Parameter returned when photos are [vk.com/dev/upload_files|uploaded to server].
	Hash string `url:"hash,omitempty"`
	// Geographical latitude, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude,omitempty"`
	// Geographical longitude, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude,omitempty"`
	// Text describing the photo. 2048 digits max.
	Caption string `url:"caption,omitempty"`
}

PhotosSaveParams are params for Photos.Save

type PhotosSaveResponse

type PhotosSaveResponse []vk.Photo

PhotosSaveResponse is response for Photos.Save

type PhotosSaveWallPhotoParams

type PhotosSaveWallPhotoParams struct {
	// ID of the user on whose wall the photo will be saved.
	UserID int `url:"user_id,omitempty"`
	// ID of community on whose wall the photo will be saved.
	GroupID int `url:"group_id,omitempty"`
	// Parameter returned when the the photo is [vk.com/dev/upload_files|uploaded to the server].
	Photo  string `url:"photo"`
	Server int    `url:"server,omitempty"`
	Hash   string `url:"hash,omitempty"`
	// Geographical latitude, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude,omitempty"`
	// Geographical longitude, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude,omitempty"`
	// Text describing the photo. 2048 digits max.
	Caption string `url:"caption,omitempty"`
}

PhotosSaveWallPhotoParams are params for Photos.SaveWallPhoto

type PhotosSaveWallPhotoResponse

type PhotosSaveWallPhotoResponse []vk.Photo

PhotosSaveWallPhotoResponse is response for Photos.SaveWallPhoto

type PhotosSearchParams

type PhotosSearchParams struct {
	// Search query string.
	Q string `url:"q,omitempty"`
	// Geographical latitude, in degrees (from '-90' to '90').
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude, in degrees (from '-180' to '180').
	Long      float32 `url:"long,omitempty"`
	StartTime int     `url:"start_time,omitempty"`
	EndTime   int     `url:"end_time,omitempty"`
	// Sort order:
	Sort int `url:"sort,omitempty"`
	// Offset needed to return a specific subset of photos.
	Offset int `url:"offset,omitempty"`
	// Number of photos to return.
	Count int `url:"count,omitempty"`
	// Radius of search in meters (works very approximately). Available values: '10', '100', '800', '6000', '50000'.
	Radius int `url:"radius,omitempty"`
}

PhotosSearchParams are params for Photos.Search

type PhotosSearchResponse

type PhotosSearchResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Photo `json:"items,omitempty"`
}

PhotosSearchResponse is response for Photos.Search

type Places

type Places struct {
	API vk.API
}

Places implements VK API namespace `places`

func (Places) Add

func (v Places) Add(params PlacesAddParams) (*PlacesAddResponse, error)

Add Adds a new location to the location database.

func (Places) Checkin

func (v Places) Checkin(params PlacesCheckinParams) (*PlacesCheckinResponse, error)

Checkin Checks a user in at the specified location.

func (Places) GetByID

GetByID Returns information about locations by their IDs.

func (Places) GetCheckins

GetCheckins Returns a list of user check-ins at locations according to the set parameters.

func (Places) GetTypes

func (v Places) GetTypes() (PlacesGetTypesResponse, error)

GetTypes Returns a list of all types of locations.

func (Places) Search

func (v Places) Search(params PlacesSearchParams) (*PlacesSearchResponse, error)

Search Returns a list of locations that match the search criteria.

type PlacesAddParams

type PlacesAddParams struct {
	// ID of the location's type (e.g., '1' — Home, '2' — Work). To get location type IDs, use the [vk.com/dev/places.getTypes|places.getTypes] method.
	Type int `url:"type,omitempty"`
	// Title of the location.
	Title string `url:"title"`
	// Geographical latitude, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude"`
	// Geographical longitude, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude"`
	// ID of the location's country. To get country IDs, use the [vk.com/dev/database.getCountries|database.getCountries] method.
	Country int `url:"country,omitempty"`
	// ID of the location's city. To get city IDs, use the [vk.com/dev/database.getCities|database.getCities] method.
	City int `url:"city,omitempty"`
	// Street address of the location (e.g., '125 Elm Street').
	Address string `url:"address,omitempty"`
}

PlacesAddParams are params for Places.Add

type PlacesAddResponse

type PlacesAddResponse struct {
	// Place ID
	ID int `json:"id,omitempty"`
}

PlacesAddResponse is response for Places.Add

type PlacesCheckinParams

type PlacesCheckinParams struct {
	// Location ID.
	PlaceID int `url:"place_id,omitempty"`
	// Text of the comment on the check-in (255 characters maximum, line breaks not supported).
	Text string `url:"text,omitempty"`
	// Geographical latitude of the check-in, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude,omitempty"`
	// Geographical longitude of the check-in, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude,omitempty"`
	// '1' — Check-in will be available only for friends. '0' — Check-in will be available for all users (default).
	FriendsOnly bool `url:"friends_only,omitempty"`
	// List of services or websites (e.g., 'twitter', 'facebook') to which the check-in will be exported, if the user has set up the respective option.
	Services CSVStringSlice `url:"services,omitempty"`
}

PlacesCheckinParams are params for Places.Checkin

type PlacesCheckinResponse

type PlacesCheckinResponse struct {
	// Checkin ID
	ID int `json:"id,omitempty"`
}

PlacesCheckinResponse is response for Places.Checkin

type PlacesGetByIDParams

type PlacesGetByIDParams struct {
	// Location IDs.
	Places CSVIntSlice `url:"places"`
}

PlacesGetByIDParams are params for Places.GetByID

type PlacesGetByIDResponse

type PlacesGetByIDResponse []vk.Place

PlacesGetByIDResponse is response for Places.GetByID

type PlacesGetCheckinsParams

type PlacesGetCheckinsParams struct {
	// Geographical latitude of the initial search point, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude,omitempty"`
	// Geographical longitude of the initial search point, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude,omitempty"`
	// Location ID of check-ins to return. (Ignored if 'latitude' and 'longitude' are specified.)
	Place  int `url:"place,omitempty"`
	UserID int `url:"user_id,omitempty"`
	// Offset needed to return a specific subset of check-ins. (Ignored if 'timestamp' is not null.)
	Offset int `url:"offset,omitempty"`
	// Number of check-ins to return. (Ignored if 'timestamp' is not null.)
	Count int `url:"count,omitempty"`
	// Specifies that only those check-ins created after the specified timestamp will be returned.
	Timestamp int `url:"timestamp,omitempty"`
	// '1' — to return only check-ins with set geographical coordinates. (Ignored if 'latitude' and 'longitude' are not set.)
	FriendsOnly bool `url:"friends_only,omitempty"`
	// '1' — to return location information with the check-ins. (Ignored if 'place' is not set.),
	NeedPlaces bool `url:"need_places,omitempty"`
}

PlacesGetCheckinsParams are params for Places.GetCheckins

type PlacesGetCheckinsResponse

type PlacesGetCheckinsResponse struct {
	// Total number
	Count int `json:"count,omitempty"`
	Items []struct {
		// Checkin ID
		ID int `json:"id,omitempty"`
		// User ID
		UserID int `json:"user_id,omitempty"`
		// Date when the checkin has been added in Unixtime
		Date int `json:"date,omitempty"`
		// Place latitude
		Latitude float32 `json:"latitude,omitempty"`
		// Place longitude
		Longitude float32 `json:"longitude,omitempty"`
		// Place ID
		PlaceID int `json:"place_id,omitempty"`
		// Comment text
		Text string `json:"text,omitempty"`
		// Distance to the place
		Distance int `json:"distance,omitempty"`
		// Place title
		PlaceTitle string `json:"place_title,omitempty"`
		// Country ID
		PlaceCountry int `json:"place_country,omitempty"`
		// City ID
		PlaceCity int `json:"place_city,omitempty"`
		// Place type
		PlaceType string `json:"place_type,omitempty"`
		// URL of the place's icon
		PlaceIcon string `json:"place_icon,omitempty"`
	} `json:"items,omitempty"`
}

PlacesGetCheckinsResponse is response for Places.GetCheckins

type PlacesGetTypesResponse

type PlacesGetTypesResponse []struct {
	// Place type ID
	ID int `json:"id,omitempty"`
	// Place type title
	Title string `json:"title,omitempty"`
	// URL of the place's icon
	Icon string `json:"icon,omitempty"`
}

PlacesGetTypesResponse is response for Places.GetTypes

type PlacesSearchParams

type PlacesSearchParams struct {
	// Search query string.
	Q string `url:"q,omitempty"`
	// City ID.
	City int `url:"city,omitempty"`
	// Geographical latitude of the initial search point, in degrees (from '-90' to '90').
	Latitude float32 `url:"latitude"`
	// Geographical longitude of the initial search point, in degrees (from '-180' to '180').
	Longitude float32 `url:"longitude"`
	// Radius of the search zone: '1' — 100 m. (default), '2' — 800 m. '3' — 6 km. '4' — 50 km.
	Radius int `url:"radius,omitempty"`
	// Offset needed to return a specific subset of locations.
	Offset int `url:"offset,omitempty"`
	// Number of locations to return.
	Count int `url:"count,omitempty"`
}

PlacesSearchParams are params for Places.Search

type PlacesSearchResponse

type PlacesSearchResponse struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Place `json:"items,omitempty"`
}

PlacesSearchResponse is response for Places.Search

type Polls

type Polls struct {
	API vk.API
}

Polls implements VK API namespace `polls`

func (Polls) AddVote

func (v Polls) AddVote(params PollsAddVoteParams) (bool, error)

AddVote Adds the current user's vote to the selected answer in the poll.

func (Polls) Create

func (v Polls) Create(params PollsCreateParams) (*PollsCreateResponse, error)

Create Creates polls that can be attached to the users' or communities' posts.

func (Polls) DeleteVote

func (v Polls) DeleteVote(params PollsDeleteVoteParams) (bool, error)

DeleteVote Deletes the current user's vote from the selected answer in the poll.

func (Polls) Edit

func (v Polls) Edit(params PollsEditParams) (bool, error)

Edit Edits created polls

func (Polls) GetByID

func (v Polls) GetByID(params PollsGetByIDParams) (*PollsGetByIDResponse, error)

GetByID Returns detailed information about a poll by its ID.

func (Polls) GetVoters

func (v Polls) GetVoters(params PollsGetVotersParams) (PollsGetVotersResponse, error)

GetVoters Returns a list of IDs of users who selected specific answers in the poll.

type PollsAddVoteParams

type PollsAddVoteParams struct {
	// ID of the user or community that owns the poll. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Poll ID.
	PollID    int         `url:"poll_id"`
	AnswerIDs CSVIntSlice `url:"answer_ids"`
	IsBoard   bool        `url:"is_board,omitempty"`
}

PollsAddVoteParams are params for Polls.AddVote

type PollsCreateParams

type PollsCreateParams struct {
	// question text
	Question string `url:"question,omitempty"`
	// '1' – anonymous poll, participants list is hidden,, '0' – public poll, participants list is available,, Default value is '0'.
	IsAnonymous bool `url:"is_anonymous,omitempty"`
	IsMultiple  bool `url:"is_multiple,omitempty"`
	EndDate     int  `url:"end_date,omitempty"`
	// If a poll will be added to a communty it is required to send a negative group identifier. Current user by default.
	OwnerID int `url:"owner_id,omitempty"`
	// available answers list, for example: " ["yes","no","maybe"]", There can be from 1 to 10 answers.
	AddAnswers   string `url:"add_answers,omitempty"`
	PhotoID      int    `url:"photo_id,omitempty"`
	BackgroundID string `url:"background_id,omitempty"`
}

PollsCreateParams are params for Polls.Create

type PollsCreateResponse

type PollsCreateResponse vk.Poll

PollsCreateResponse is response for Polls.Create

type PollsDeleteVoteParams

type PollsDeleteVoteParams struct {
	// ID of the user or community that owns the poll. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Poll ID.
	PollID int `url:"poll_id"`
	// Answer ID.
	AnswerID int  `url:"answer_id"`
	IsBoard  bool `url:"is_board,omitempty"`
}

PollsDeleteVoteParams are params for Polls.DeleteVote

type PollsEditParams

type PollsEditParams struct {
	// poll owner id
	OwnerID int `url:"owner_id,omitempty"`
	// edited poll's id
	PollID int `url:"poll_id"`
	// new question text
	Question string `url:"question,omitempty"`
	// answers list, for example: , "["yes","no","maybe"]"
	AddAnswers string `url:"add_answers,omitempty"`
	// object containing answers that need to be edited,, key – answer id, value – new answer text. Example: {"382967099":"option1", "382967103":"option2"}"
	EditAnswers string `url:"edit_answers,omitempty"`
	// list of answer ids to be deleted. For example: "[382967099, 382967103]"
	DeleteAnswers string `url:"delete_answers,omitempty"`
	EndDate       int    `url:"end_date,omitempty"`
	PhotoID       int    `url:"photo_id,omitempty"`
	BackgroundID  string `url:"background_id,omitempty"`
}

PollsEditParams are params for Polls.Edit

type PollsGetByIDParams

type PollsGetByIDParams struct {
	// ID of the user or community that owns the poll. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// '1' – poll is in a board, '0' – poll is on a wall. '0' by default.
	IsBoard bool `url:"is_board,omitempty"`
	// Poll ID.
	PollID       int            `url:"poll_id"`
	Extended     bool           `url:"extended,omitempty"`
	FriendsCount int            `url:"friends_count,omitempty"`
	Fields       CSVStringSlice `url:"fields,omitempty"`
	NameCase     string         `url:"name_case,omitempty"`
}

PollsGetByIDParams are params for Polls.GetByID

type PollsGetByIDResponse

type PollsGetByIDResponse vk.Poll

PollsGetByIDResponse is response for Polls.GetByID

type PollsGetVotersParams

type PollsGetVotersParams struct {
	// ID of the user or community that owns the poll. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Poll ID.
	PollID int `url:"poll_id"`
	// Answer IDs.
	AnswerIDs CSVIntSlice `url:"answer_ids"`
	IsBoard   bool        `url:"is_board,omitempty"`
	// '1' — to return only current user's friends, '0' — to return all users (default),
	FriendsOnly bool `url:"friends_only,omitempty"`
	// Offset needed to return a specific subset of voters. '0' — (default)
	Offset int `url:"offset,omitempty"`
	// Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000', otherwise '10'). '100' — (default)
	Count int `url:"count,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

PollsGetVotersParams are params for Polls.GetVoters

type PollsGetVotersResponse

type PollsGetVotersResponse []struct {
	// Answer ID
	AnswerID int `json:"answer_id,omitempty"`
	Users    struct {
		// Votes number
		Count int `json:"count,omitempty"`
		// User ID
		Items []int `json:"items,omitempty"`
	} `json:"users,omitempty"`
}

PollsGetVotersResponse is response for Polls.GetVoters

type Search struct {
	API vk.API
}

Search implements VK API namespace `search`

func (Search) GetHints

GetHints Allows the programmer to do a quick search for any substring.

type SearchGetHintsParams

type SearchGetHintsParams struct {
	// Search query string.
	Q string `url:"q,omitempty"`
	// Offset for querying specific result subset
	Offset int `url:"offset,omitempty"`
	// Maximum number of results to return.
	Limit        int            `url:"limit,omitempty"`
	Filters      CSVStringSlice `url:"filters,omitempty"`
	Fields       CSVStringSlice `url:"fields,omitempty"`
	SearchGlobal bool           `url:"search_global,omitempty"`
}

SearchGetHintsParams are params for Search.GetHints

type SearchGetHintsResponse

type SearchGetHintsResponse struct {
	Items []struct {
		// Object type
		Type string `json:"type,omitempty"`
		// Section title
		Section string `json:"section,omitempty"`
		// Object description
		Description string `json:"description,omitempty"`
		// Information whether the object has been found globally
		Global  vk.BoolInt `json:"global,omitempty"`
		Group   vk.Group   `json:"group,omitempty"`
		Profile vk.User    `json:"profile,omitempty"`
	} `json:"items,omitempty"`
	SuggestedQueries []string `json:"suggested_queries,omitempty"`
}

SearchGetHintsResponse is response for Search.GetHints

type Secure

type Secure struct {
	API vk.API
}

Secure implements VK API namespace `secure`

func (Secure) AddAppEvent

func (v Secure) AddAppEvent(params SecureAddAppEventParams) (bool, error)

AddAppEvent Adds user activity information to an application

func (Secure) CheckToken

CheckToken Checks the user authentication in 'IFrame' and 'Flash' apps using the 'access_token' parameter.

func (Secure) GetAppBalance

func (v Secure) GetAppBalance() (SecureGetAppBalanceResponse, error)

GetAppBalance Returns payment balance of the application in hundredth of a vote.

func (Secure) GetSMSHistory

GetSMSHistory Shows a list of SMS notifications sent by the application using [vk.com/dev/secure.sendSMSNotification|secure.sendSMSNotification] method.

func (Secure) GetTransactionsHistory

GetTransactionsHistory Shows history of votes transaction between users and the application.

func (Secure) GetUserLevel

GetUserLevel Returns one of the previously set game levels of one or more users in the application.

func (Secure) SendNotification

SendNotification Sends notification to the user.

func (Secure) SendSMSNotification

func (v Secure) SendSMSNotification(params SecureSendSMSNotificationParams) (bool, error)

SendSMSNotification Sends 'SMS' notification to a user's mobile device.

func (Secure) SetCounter

func (v Secure) SetCounter(params SecureSetCounterParams) (bool, error)

SetCounter Sets a counter which is shown to the user in bold in the left menu.

type SecureAddAppEventParams

type SecureAddAppEventParams struct {
	// ID of a user to save the data
	UserID int `url:"user_id"`
	// there are 2 default activities: , * 1 – level. Works similar to ,, * 2 – points, saves points amount, Any other value is for saving completed missions
	ActivityID int `url:"activity_id"`
	// depends on activity_id: * 1 – number, current level number,, * 2 – number, current user's points amount, , Any other value is ignored
	Value int `url:"value,omitempty"`
}

SecureAddAppEventParams are params for Secure.AddAppEvent

type SecureCheckTokenParams

type SecureCheckTokenParams struct {
	// client 'access_token'
	Token string `url:"token,omitempty"`
	// user 'ip address'. Note that user may access using the 'ipv6' address, in this case it is required to transmit the 'ipv6' address. If not transmitted, the address will not be checked.
	IP string `url:"ip,omitempty"`
}

SecureCheckTokenParams are params for Secure.CheckToken

type SecureCheckTokenResponse

type SecureCheckTokenResponse struct {
	// Returns if successfully processed
	Success vk.BoolInt `json:"success,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
	// Date when access_token has been generated in Unixtime
	Date int `json:"date,omitempty"`
	// Date when access_token will expire in Unixtime
	Expire int `json:"expire,omitempty"`
}

SecureCheckTokenResponse is response for Secure.CheckToken

type SecureGetAppBalanceResponse

type SecureGetAppBalanceResponse int

SecureGetAppBalanceResponse is response for Secure.GetAppBalance App balance

type SecureGetSMSHistoryParams

type SecureGetSMSHistoryParams struct {
	UserID int `url:"user_id,omitempty"`
	// filter by start date. It is set as UNIX-time.
	DateFrom int `url:"date_from,omitempty"`
	// filter by end date. It is set as UNIX-time.
	DateTo int `url:"date_to,omitempty"`
	// number of returned posts. By default — 1000.
	Limit int `url:"limit,omitempty"`
}

SecureGetSMSHistoryParams are params for Secure.GetSMSHistory

type SecureGetSMSHistoryResponse

type SecureGetSMSHistoryResponse []struct {
	// Notification ID
	ID int `json:"id,omitempty"`
	// Application ID
	AppID int `json:"app_id,omitempty"`
	// User ID
	UserID int `json:"user_id,omitempty"`
	// Date when message has been sent in Unixtime
	Date int `json:"date,omitempty"`
	// Messsage text
	Message string `json:"message,omitempty"`
}

SecureGetSMSHistoryResponse is response for Secure.GetSMSHistory

type SecureGetTransactionsHistoryParams

type SecureGetTransactionsHistoryParams struct {
	Type     int `url:"type,omitempty"`
	UIDFrom  int `url:"uid_from,omitempty"`
	UIDTo    int `url:"uid_to,omitempty"`
	DateFrom int `url:"date_from,omitempty"`
	DateTo   int `url:"date_to,omitempty"`
	Limit    int `url:"limit,omitempty"`
}

SecureGetTransactionsHistoryParams are params for Secure.GetTransactionsHistory

type SecureGetTransactionsHistoryResponse

type SecureGetTransactionsHistoryResponse []struct {
	// Transaction ID
	ID int `json:"id,omitempty"`
	// From ID
	UIDFrom int `json:"uid_from,omitempty"`
	// To ID
	UIDTo int `json:"uid_to,omitempty"`
	// Votes number
	Votes int `json:"votes,omitempty"`
	// Transaction date in Unixtime
	Date int `json:"date,omitempty"`
}

SecureGetTransactionsHistoryResponse is response for Secure.GetTransactionsHistory

type SecureGetUserLevelParams

type SecureGetUserLevelParams struct {
	UserIDs CSVIntSlice `url:"user_ids"`
}

SecureGetUserLevelParams are params for Secure.GetUserLevel

type SecureGetUserLevelResponse

type SecureGetUserLevelResponse []struct {
	// User ID
	UID int `json:"uid,omitempty"`
	// Level
	Level int `json:"level,omitempty"`
}

SecureGetUserLevelResponse is response for Secure.GetUserLevel

type SecureSendNotificationParams

type SecureSendNotificationParams struct {
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	UserID  int         `url:"user_id,omitempty"`
	// notification text which should be sent in 'UTF-8' encoding ('254' characters maximum).
	Message string `url:"message"`
}

SecureSendNotificationParams are params for Secure.SendNotification

type SecureSendNotificationResponse

type SecureSendNotificationResponse []int

SecureSendNotificationResponse is response for Secure.SendNotification User ID

type SecureSendSMSNotificationParams

type SecureSendSMSNotificationParams struct {
	// ID of the user to whom SMS notification is sent. The user shall allow the application to send him/her notifications (, +1).
	UserID int `url:"user_id"`
	// 'SMS' text to be sent in 'UTF-8' encoding. Only Latin letters and numbers are allowed. Maximum size is '160' characters.
	Message string `url:"message"`
}

SecureSendSMSNotificationParams are params for Secure.SendSMSNotification

type SecureSetCounterParams

type SecureSetCounterParams struct {
	Counters CSVStringSlice `url:"counters,omitempty"`
	UserID   int            `url:"user_id,omitempty"`
	// counter value.
	Counter   int  `url:"counter,omitempty"`
	Increment bool `url:"increment,omitempty"`
}

SecureSetCounterParams are params for Secure.SetCounter

type Stats

type Stats struct {
	API vk.API
}

Stats implements VK API namespace `stats`

func (Stats) Get

func (v Stats) Get(params StatsGetParams) (StatsGetResponse, error)

Get Returns statistics of a community or an application.

func (Stats) GetPostReach

GetPostReach Returns stats for a wall post.

func (Stats) TrackVisitor

func (v Stats) TrackVisitor(params StatsTrackVisitorParams) (bool, error)

TrackVisitor does stats.trackVisitor

type StatsGetParams

type StatsGetParams struct {
	// Community ID.
	GroupID int `url:"group_id,omitempty"`
	// Application ID.
	AppID          int            `url:"app_id,omitempty"`
	TimestampFrom  int            `url:"timestamp_from,omitempty"`
	TimestampTo    int            `url:"timestamp_to,omitempty"`
	Interval       string         `url:"interval,omitempty"`
	IntervalsCount int            `url:"intervals_count,omitempty"`
	Filters        CSVStringSlice `url:"filters,omitempty"`
	StatsGroups    CSVStringSlice `url:"stats_groups,omitempty"`
	Extended       bool           `url:"extended,omitempty"`
}

StatsGetParams are params for Stats.Get

type StatsGetPostReachParams

type StatsGetPostReachParams struct {
	// post owner community id. Specify with "-" sign.
	OwnerID int `url:"owner_id"`
	// wall post id. Note that stats are available only for '300' last (newest) posts on a community wall.
	PostID int `url:"post_id"`
}

StatsGetPostReachParams are params for Stats.GetPostReach

type StatsGetPostReachResponse

type StatsGetPostReachResponse []vk.WallpostStats

StatsGetPostReachResponse is response for Stats.GetPostReach

type StatsGetResponse

type StatsGetResponse []genTODOType /* objects.json#/definitions/stats_period */

StatsGetResponse is response for Stats.Get

type StatsTrackVisitorParams

type StatsTrackVisitorParams struct {
	ID string `url:"id"`
}

StatsTrackVisitorParams are params for Stats.TrackVisitor

type Status

type Status struct {
	API vk.API
}

Status implements VK API namespace `status`

func (Status) Get

func (v Status) Get(params StatusGetParams) (*StatusGetResponse, error)

Get Returns data required to show the status of a user or community.

func (Status) Set

func (v Status) Set(params StatusSetParams) (bool, error)

Set Sets a new status for the current user.

type StatusGetParams

type StatusGetParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	UserID  int `url:"user_id,omitempty"`
	GroupID int `url:"group_id,omitempty"`
}

StatusGetParams are params for Status.Get

type StatusGetResponse

type StatusGetResponse struct {
	// Status text
	Text  string   `json:"text,omitempty"`
	Audio vk.Audio `json:"audio,omitempty"`
}

StatusGetResponse is response for Status.Get

type StatusSetParams

type StatusSetParams struct {
	// Text of the new status.
	Text string `url:"text,omitempty"`
	// Identifier of a community to set a status in. If left blank the status is set to current user.
	GroupID int `url:"group_id,omitempty"`
}

StatusSetParams are params for Status.Set

type Storage

type Storage struct {
	API vk.API
}

Storage implements VK API namespace `storage`

func (Storage) Get

Get Returns a value of variable with the name set by key parameter.

func (Storage) GetKeys

GetKeys Returns the names of all variables.

func (Storage) Set

func (v Storage) Set(params StorageSetParams) (bool, error)

Set Saves a value of variable with the name set by 'key' parameter.

type StorageGetKeysParams

type StorageGetKeysParams struct {
	// user id, whose variables names are returned if they were requested with a server method.
	UserID int  `url:"user_id,omitempty"`
	Global bool `url:"global,omitempty"`
	Offset int  `url:"offset,omitempty"`
	// amount of variable names the info needs to be collected from.
	Count int `url:"count,omitempty"`
}

StorageGetKeysParams are params for Storage.GetKeys

type StorageGetKeysResponse

type StorageGetKeysResponse []string

StorageGetKeysResponse is response for Storage.GetKeys Key name

type StorageGetParams

type StorageGetParams struct {
	Key    string         `url:"key,omitempty"`
	Keys   CSVStringSlice `url:"keys,omitempty"`
	UserID int            `url:"user_id,omitempty"`
	Global bool           `url:"global,omitempty"`
}

StorageGetParams are params for Storage.Get

type StorageGetResponse

type StorageGetResponse string

StorageGetResponse is response for Storage.Get Key value

type StorageSetParams

type StorageSetParams struct {
	Key    string `url:"key"`
	Value  string `url:"value,omitempty"`
	UserID int    `url:"user_id,omitempty"`
	Global bool   `url:"global,omitempty"`
}

StorageSetParams are params for Storage.Set

type Stories

type Stories struct {
	API vk.API
}

Stories implements VK API namespace `stories`

func (Stories) BanOwner

func (v Stories) BanOwner(params StoriesBanOwnerParams) (bool, error)

BanOwner Allows to hide stories from chosen sources from current user's feed.

func (Stories) Delete

func (v Stories) Delete(params StoriesDeleteParams) (bool, error)

Delete Allows to delete story.

func (Stories) Get

Get Returns stories available for current user.

func (Stories) GetBanned

GetBanned Returns list of sources hidden from current user's feed.

func (Stories) GetByID

GetByID Returns story by its ID.

func (Stories) GetPhotoUploadServer

GetPhotoUploadServer Returns URL for uploading a story with photo.

func (Stories) GetReplies

GetReplies Returns replies to the story.

func (Stories) GetStats

GetStats Returns stories available for current user.

func (Stories) GetVideoUploadServer

GetVideoUploadServer Allows to receive URL for uploading story with video.

func (Stories) GetViewers

GetViewers Returns a list of story viewers.

func (Stories) HideAllReplies

func (v Stories) HideAllReplies(params StoriesHideAllRepliesParams) (bool, error)

HideAllReplies Hides all replies in the last 24 hours from the user to current user's stories.

func (Stories) HideReply

func (v Stories) HideReply(params StoriesHideReplyParams) (bool, error)

HideReply Hides the reply to the current user's story.

func (Stories) UnbanOwner

func (v Stories) UnbanOwner(params StoriesUnbanOwnerParams) (bool, error)

UnbanOwner Allows to show stories from hidden sources in current user's feed.

type StoriesBanOwnerParams

type StoriesBanOwnerParams struct {
	// List of sources IDs
	OwnersIDs CSVIntSlice `url:"owners_ids"`
}

StoriesBanOwnerParams are params for Stories.BanOwner

type StoriesDeleteParams

type StoriesDeleteParams struct {
	// Story owner's ID. Current user id is used by default.
	OwnerID int `url:"owner_id"`
	// Story ID.
	StoryID int `url:"story_id"`
}

StoriesDeleteParams are params for Stories.Delete

type StoriesGetBannedParams

type StoriesGetBannedParams struct {
	// '1' — to return additional fields for users and communities. Default value is 0.
	Extended bool `url:"extended,omitempty"`
	// Additional fields to return
	Fields CSVStringSlice `url:"fields,omitempty"`
}

StoriesGetBannedParams are params for Stories.GetBanned

type StoriesGetBannedResponse

type StoriesGetBannedResponse interface {
	// contains filtered or unexported methods
}

StoriesGetBannedResponse is response for Stories.GetBanned Either StoriesGetBannedResponseNormal or StoriesGetBannedResponseExtended, depending on Extended flag

type StoriesGetBannedResponseExtended

type StoriesGetBannedResponseExtended struct {
	// Stories count
	Count int `json:"count,omitempty"`
	// Owner ID
	Items    []int      `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

StoriesGetBannedResponseExtended is extended version of StoriesGetBannedResponse

type StoriesGetBannedResponseNormal

type StoriesGetBannedResponseNormal struct {
	// Stories count
	Count int `json:"count,omitempty"`
	// Owner ID
	Items []int `json:"items,omitempty"`
}

StoriesGetBannedResponseNormal is non-extended version of StoriesGetBannedResponse

type StoriesGetByIDParams

type StoriesGetByIDParams struct {
	// Stories IDs separated by commas. Use format {owner_id}+'_'+{story_id}, for example, 12345_54331.
	Stories CSVStringSlice `url:"stories"`
	// '1' — to return additional fields for users and communities. Default value is 0.
	Extended bool `url:"extended,omitempty"`
	// Additional fields to return
	Fields CSVStringSlice `url:"fields,omitempty"`
}

StoriesGetByIDParams are params for Stories.GetByID

type StoriesGetByIDResponse

type StoriesGetByIDResponse interface {
	// contains filtered or unexported methods
}

StoriesGetByIDResponse is response for Stories.GetByID Either StoriesGetByIDResponseNormal or StoriesGetByIDResponseExtended, depending on Extended flag

type StoriesGetByIDResponseExtended

type StoriesGetByIDResponseExtended struct {
	// Stories count
	Count    int        `json:"count,omitempty"`
	Items    []vk.Story `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

StoriesGetByIDResponseExtended is extended version of StoriesGetByIDResponse

type StoriesGetByIDResponseNormal

type StoriesGetByIDResponseNormal struct {
	// Stories count
	Count int        `json:"count,omitempty"`
	Items []vk.Story `json:"items,omitempty"`
}

StoriesGetByIDResponseNormal is non-extended version of StoriesGetByIDResponse

type StoriesGetParams

type StoriesGetParams struct {
	// Owner ID.
	OwnerID int `url:"owner_id,omitempty"`
	// '1' — to return additional fields for users and communities. Default value is 0.
	Extended bool `url:"extended,omitempty"`
}

StoriesGetParams are params for Stories.Get

type StoriesGetPhotoUploadServerParams

type StoriesGetPhotoUploadServerParams struct {
	// 1 — to add the story to friend's feed.
	AddToNews bool `url:"add_to_news,omitempty"`
	// List of users IDs who can see the story.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// ID of the story to reply with the current.
	ReplyToStory string `url:"reply_to_story,omitempty"`
	// Link text (for community's stories only).
	LinkText string `url:"link_text,omitempty"`
	// Link URL. Internal links on https://vk.com only.
	LinkURL string `url:"link_url,omitempty"`
	// ID of the community to upload the story (should be verified or with the "fire" icon).
	GroupID int `url:"group_id,omitempty"`
}

StoriesGetPhotoUploadServerParams are params for Stories.GetPhotoUploadServer

type StoriesGetPhotoUploadServerResponse

type StoriesGetPhotoUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
	// Users ID who can to see story.
	UserIDs []int `json:"user_ids,omitempty"`
}

StoriesGetPhotoUploadServerResponse is response for Stories.GetPhotoUploadServer

type StoriesGetRepliesParams

type StoriesGetRepliesParams struct {
	// Story owner ID.
	OwnerID int `url:"owner_id"`
	// Story ID.
	StoryID int `url:"story_id"`
	// Access key for the private object.
	AccessKey string `url:"access_key,omitempty"`
	// '1' — to return additional fields for users and communities. Default value is 0.
	Extended bool `url:"extended,omitempty"`
	// Additional fields to return
	Fields CSVStringSlice `url:"fields,omitempty"`
}

StoriesGetRepliesParams are params for Stories.GetReplies

type StoriesGetRepliesResponse

type StoriesGetRepliesResponse interface {
	// contains filtered or unexported methods
}

StoriesGetRepliesResponse is response for Stories.GetReplies Either StoriesGetRepliesResponseNormal or StoriesGetRepliesResponseExtended, depending on Extended flag

type StoriesGetRepliesResponseExtended

type StoriesGetRepliesResponseExtended struct {
	// Stories count
	Count    int          `json:"count,omitempty"`
	Items    [][]vk.Story `json:"items,omitempty"`
	Profiles []vk.User    `json:"profiles,omitempty"`
	Groups   []vk.Group   `json:"groups,omitempty"`
}

StoriesGetRepliesResponseExtended is extended version of StoriesGetRepliesResponse

type StoriesGetRepliesResponseNormal

type StoriesGetRepliesResponseNormal struct {
	// Stories count
	Count int          `json:"count,omitempty"`
	Items [][]vk.Story `json:"items,omitempty"`
}

StoriesGetRepliesResponseNormal is non-extended version of StoriesGetRepliesResponse

type StoriesGetResponse

type StoriesGetResponse interface {
	// contains filtered or unexported methods
}

StoriesGetResponse is response for Stories.Get Either StoriesGetResponseNormal or StoriesGetResponseExtended, depending on Extended flag

type StoriesGetResponseExtended

type StoriesGetResponseExtended struct {
	// Stories count
	Count    int          `json:"count,omitempty"`
	Items    [][]vk.Story `json:"items,omitempty"`
	Profiles []vk.User    `json:"profiles,omitempty"`
	Groups   []vk.Group   `json:"groups,omitempty"`
}

StoriesGetResponseExtended is extended version of StoriesGetResponse

type StoriesGetResponseNormal

type StoriesGetResponseNormal struct {
	// Stories count
	Count int          `json:"count,omitempty"`
	Items [][]vk.Story `json:"items,omitempty"`
}

StoriesGetResponseNormal is non-extended version of StoriesGetResponse

type StoriesGetStatsParams

type StoriesGetStatsParams struct {
	// Story owner ID.
	OwnerID int `url:"owner_id"`
	// Story ID.
	StoryID int `url:"story_id"`
}

StoriesGetStatsParams are params for Stories.GetStats

type StoriesGetStatsResponse

type StoriesGetStatsResponse struct {
	Views struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"views,omitempty"`
	Replies struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"replies,omitempty"`
	Answer struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"answer,omitempty"`
	Shares struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"shares,omitempty"`
	Subscribers struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"subscribers,omitempty"`
	Bans struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"bans,omitempty"`
	OpenLink struct {
		// Statistic state
		State string `json:"state,omitempty"`
		// Stat value
		Count int `json:"count,omitempty"`
	} `json:"open_link,omitempty"`
}

StoriesGetStatsResponse is response for Stories.GetStats

type StoriesGetVideoUploadServerParams

type StoriesGetVideoUploadServerParams struct {
	// 1 — to add the story to friend's feed.
	AddToNews bool `url:"add_to_news,omitempty"`
	// List of users IDs who can see the story.
	UserIDs CSVIntSlice `url:"user_ids,omitempty"`
	// ID of the story to reply with the current.
	ReplyToStory string `url:"reply_to_story,omitempty"`
	// Link text (for community's stories only).
	LinkText string `url:"link_text,omitempty"`
	// Link URL. Internal links on https://vk.com only.
	LinkURL string `url:"link_url,omitempty"`
	// ID of the community to upload the story (should be verified or with the "fire" icon).
	GroupID int `url:"group_id,omitempty"`
}

StoriesGetVideoUploadServerParams are params for Stories.GetVideoUploadServer

type StoriesGetVideoUploadServerResponse

type StoriesGetVideoUploadServerResponse struct {
	// Upload URL
	UploadURL string `json:"upload_url,omitempty"`
	// Users ID who can to see story.
	UserIDs []int `json:"user_ids,omitempty"`
}

StoriesGetVideoUploadServerResponse is response for Stories.GetVideoUploadServer

type StoriesGetViewersParams

type StoriesGetViewersParams struct {
	// Story owner ID.
	OwnerID int `url:"owner_id"`
	// Story ID.
	StoryID int `url:"story_id"`
	// Maximum number of results.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of results.
	Offset int `url:"offset,omitempty"`
	// '1' — to return detailed information about photos
	Extended bool `url:"extended,omitempty"`
}

StoriesGetViewersParams are params for Stories.GetViewers

type StoriesGetViewersResponse

type StoriesGetViewersResponse interface {
	// contains filtered or unexported methods
}

StoriesGetViewersResponse is response for Stories.GetViewers Either StoriesGetViewersResponseNormal or StoriesGetViewersResponseExtended, depending on Extended flag

type StoriesGetViewersResponseExtended

type StoriesGetViewersResponseExtended struct {
	// Viewers count
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

StoriesGetViewersResponseExtended is extended version of StoriesGetViewersResponse

type StoriesGetViewersResponseNormal

type StoriesGetViewersResponseNormal struct {
	// Viewers count
	Count int   `json:"count,omitempty"`
	Items []int `json:"items,omitempty"`
}

StoriesGetViewersResponseNormal is non-extended version of StoriesGetViewersResponse

type StoriesHideAllRepliesParams

type StoriesHideAllRepliesParams struct {
	// ID of the user whose replies should be hidden.
	OwnerID int `url:"owner_id"`
	GroupID int `url:"group_id,omitempty"`
}

StoriesHideAllRepliesParams are params for Stories.HideAllReplies

type StoriesHideReplyParams

type StoriesHideReplyParams struct {
	// ID of the user whose replies should be hidden.
	OwnerID int `url:"owner_id"`
	// Story ID.
	StoryID int `url:"story_id"`
	// Access key for the private object.
	AccessKey string `url:"access_key,omitempty"`
}

StoriesHideReplyParams are params for Stories.HideReply

type StoriesUnbanOwnerParams

type StoriesUnbanOwnerParams struct {
	// List of hidden sources to show stories from.
	OwnersIDs CSVIntSlice `url:"owners_ids"`
}

StoriesUnbanOwnerParams are params for Stories.UnbanOwner

type Streaming

type Streaming struct {
	API vk.API
}

Streaming implements VK API namespace `streaming`

func (Streaming) GetServerURL

func (v Streaming) GetServerURL() (*StreamingGetServerURLResponse, error)

GetServerURL Allows to receive data for the connection to Streaming API.

func (Streaming) SetSettings

func (v Streaming) SetSettings(params StreamingSetSettingsParams) (bool, error)

SetSettings does streaming.setSettings

type StreamingGetServerURLResponse

type StreamingGetServerURLResponse struct {
	// Server host
	Endpoint string `json:"endpoint,omitempty"`
	// Access key
	Key string `json:"key,omitempty"`
}

StreamingGetServerURLResponse is response for Streaming.GetServerURL

type StreamingSetSettingsParams

type StreamingSetSettingsParams struct {
	MonthlyTier string `url:"monthly_tier,omitempty"`
}

StreamingSetSettingsParams are params for Streaming.SetSettings

type Users

type Users struct {
	API vk.API
}

Users implements VK API namespace `users`

func (Users) Get

func (v Users) Get(params UsersGetParams) (UsersGetResponse, error)

Get Returns detailed information on users.

func (Users) GetFollowers

func (v Users) GetFollowers(params UsersGetFollowersParams) (*UsersGetFollowersResponse, error)

GetFollowers Returns a list of IDs of followers of the user in question, sorted by date added, most recent first.

func (Users) GetNearby

func (v Users) GetNearby(params UsersGetNearbyParams) (*UsersGetNearbyResponse, error)

GetNearby Indexes current user location and returns nearby users.

func (Users) GetSubscriptions

GetSubscriptions Returns a list of IDs of users and communities followed by the user.

func (Users) IsAppUser

func (v Users) IsAppUser(params UsersIsAppUserParams) (bool, error)

IsAppUser Returns information whether a user installed the application.

func (Users) Report

func (v Users) Report(params UsersReportParams) (bool, error)

Report Reports (submits a complain about) a user.

func (Users) Search

func (v Users) Search(params UsersSearchParams) (*UsersSearchResponse, error)

Search Returns a list of users matching the search criteria.

type UsersGetFollowersParams

type UsersGetFollowersParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// Offset needed to return a specific subset of followers.
	Offset int `url:"offset,omitempty"`
	// Number of followers to return.
	Count int `url:"count,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online'.
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

UsersGetFollowersParams are params for Users.GetFollowers

type UsersGetFollowersResponse

type UsersGetFollowersResponse struct {
	// Total friends number
	Count int `json:"count,omitempty"`
	// User ID
	Items []int `json:"items,omitempty"`
}

UsersGetFollowersResponse is response for Users.GetFollowers

type UsersGetNearbyParams

type UsersGetNearbyParams struct {
	// geographic latitude of the place a user is located, in degrees (from -90 to 90)
	Latitude float32 `url:"latitude"`
	// geographic longitude of the place a user is located, in degrees (from -180 to 180)
	Longitude float32 `url:"longitude"`
	// current location accuracy in meters
	Accuracy int `url:"accuracy,omitempty"`
	// time when a user disappears from location search results, in seconds
	Timeout int `url:"timeout,omitempty"`
	// search zone radius type (1 to 4), :* 1 – 300 m,, :* 2 – 2400 m,, :* 3 – 18 km,, :* 4 – 150 km.
	Radius int `url:"radius,omitempty"`
	// list of additional fields to return. Available values: sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters, screen_name, maiden_name, timezone, occupation
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: , nom –nominative (default) , gen – genitive , dat – dative , acc – accusative , ins – instrumental , abl – prepositional
	NameCase string `url:"name_case,omitempty"`
}

UsersGetNearbyParams are params for Users.GetNearby

type UsersGetNearbyResponse

type UsersGetNearbyResponse struct {
	// Users number
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

UsersGetNearbyResponse is response for Users.GetNearby

type UsersGetParams

type UsersGetParams struct {
	// User IDs or screen names ('screen_name'). By default, current user ID.
	UserIDs CSVStringSlice `url:"user_ids,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities',
	Fields CSVStringSlice `url:"fields,omitempty"`
	// Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
	NameCase string `url:"name_case,omitempty"`
}

UsersGetParams are params for Users.Get

type UsersGetResponse

type UsersGetResponse []vk.User

UsersGetResponse is response for Users.Get

type UsersGetSubscriptionsParams

type UsersGetSubscriptionsParams struct {
	// User ID.
	UserID int `url:"user_id,omitempty"`
	// '1' — to return a combined list of users and communities, '0' — to return separate lists of users and communities (default)
	Extended bool `url:"extended,omitempty"`
	// Offset needed to return a specific subset of subscriptions.
	Offset int `url:"offset,omitempty"`
	// Number of users and communities to return.
	Count  int            `url:"count,omitempty"`
	Fields CSVStringSlice `url:"fields,omitempty"`
}

UsersGetSubscriptionsParams are params for Users.GetSubscriptions

type UsersGetSubscriptionsResponse

type UsersGetSubscriptionsResponse interface {
	// contains filtered or unexported methods
}

UsersGetSubscriptionsResponse is response for Users.GetSubscriptions Either UsersGetSubscriptionsResponseNormal or UsersGetSubscriptionsResponseExtended, depending on Extended flag

type UsersGetSubscriptionsResponseExtended

type UsersGetSubscriptionsResponseExtended struct {
	// Total number of available results
	Count int         `json:"count,omitempty"`
	Items genTODOType `json:"items,omitempty"`
}

UsersGetSubscriptionsResponseExtended is extended version of UsersGetSubscriptionsResponse

type UsersGetSubscriptionsResponseNormal

type UsersGetSubscriptionsResponseNormal struct {
	Users struct {
		// Users number
		Count int `json:"count,omitempty"`
		// User ID
		Items []int `json:"items,omitempty"`
	} `json:"users,omitempty"`
	Groups struct {
		// Communities number
		Count int `json:"count,omitempty"`
		// Community ID
		Items []int `json:"items,omitempty"`
	} `json:"groups,omitempty"`
}

UsersGetSubscriptionsResponseNormal is non-extended version of UsersGetSubscriptionsResponse

type UsersIsAppUserParams

type UsersIsAppUserParams struct {
	UserID int `url:"user_id,omitempty"`
}

UsersIsAppUserParams are params for Users.IsAppUser

type UsersReportParams

type UsersReportParams struct {
	// ID of the user about whom a complaint is being made.
	UserID int `url:"user_id"`
	// Type of complaint: 'porn' – pornography, 'spam' – spamming, 'insult' – abusive behavior, 'advertisment' – disruptive advertisements
	Type string `url:"type"`
	// Comment describing the complaint.
	Comment string `url:"comment,omitempty"`
}

UsersReportParams are params for Users.Report

type UsersSearchParams

type UsersSearchParams struct {
	// Search query string (e.g., 'Vasya Babich').
	Q string `url:"q,omitempty"`
	// Sort order: '1' — by date registered, '0' — by rating
	Sort int `url:"sort,omitempty"`
	// Offset needed to return a specific subset of users.
	Offset int `url:"offset,omitempty"`
	// Number of users to return.
	Count int `url:"count,omitempty"`
	// Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online',
	Fields CSVStringSlice `url:"fields,omitempty"`
	// City ID.
	City int `url:"city,omitempty"`
	// Country ID.
	Country int `url:"country,omitempty"`
	// City name in a string.
	Hometown string `url:"hometown,omitempty"`
	// ID of the country where the user graduated.
	UniversityCountry int `url:"university_country,omitempty"`
	// ID of the institution of higher education.
	University int `url:"university,omitempty"`
	// Year of graduation from an institution of higher education.
	UniversityYear int `url:"university_year,omitempty"`
	// Faculty ID.
	UniversityFaculty int `url:"university_faculty,omitempty"`
	// Chair ID.
	UniversityChair int `url:"university_chair,omitempty"`
	// '1' — female, '2' — male, '0' — any (default)
	Sex int `url:"sex,omitempty"`
	// Relationship status: '1' — Not married, '2' — In a relationship, '3' — Engaged, '4' — Married, '5' — It's complicated, '6' — Actively searching, '7' — In love
	Status int `url:"status,omitempty"`
	// Minimum age.
	AgeFrom int `url:"age_from,omitempty"`
	// Maximum age.
	AgeTo int `url:"age_to,omitempty"`
	// Day of birth.
	BirthDay int `url:"birth_day,omitempty"`
	// Month of birth.
	BirthMonth int `url:"birth_month,omitempty"`
	// Year of birth.
	BirthYear int `url:"birth_year,omitempty"`
	// '1' — online only, '0' — all users
	Online bool `url:"online,omitempty"`
	// '1' — with photo only, '0' — all users
	HasPhoto bool `url:"has_photo,omitempty"`
	// ID of the country where users finished school.
	SchoolCountry int `url:"school_country,omitempty"`
	// ID of the city where users finished school.
	SchoolCity  int `url:"school_city,omitempty"`
	SchoolClass int `url:"school_class,omitempty"`
	// ID of the school.
	School int `url:"school,omitempty"`
	// School graduation year.
	SchoolYear int `url:"school_year,omitempty"`
	// Users' religious affiliation.
	Religion string `url:"religion,omitempty"`
	// Users' interests.
	Interests string `url:"interests,omitempty"`
	// Name of the company where users work.
	Company string `url:"company,omitempty"`
	// Job position.
	Position string `url:"position,omitempty"`
	// ID of a community to search in communities.
	GroupID  int            `url:"group_id,omitempty"`
	FromList CSVStringSlice `url:"from_list,omitempty"`
}

UsersSearchParams are params for Users.Search

type UsersSearchResponse

type UsersSearchResponse struct {
	// Total number of available results
	Count int       `json:"count,omitempty"`
	Items []vk.User `json:"items,omitempty"`
}

UsersSearchResponse is response for Users.Search

type Utils

type Utils struct {
	API vk.API
}

Utils implements VK API namespace `utils`

func (v Utils) CheckLink(params UtilsCheckLinkParams) (*UtilsCheckLinkResponse, error)

CheckLink Checks whether a link is blocked in VK.

func (Utils) DeleteFromLastShortened

func (v Utils) DeleteFromLastShortened(params UtilsDeleteFromLastShortenedParams) (bool, error)

DeleteFromLastShortened Deletes shortened link from user's list.

GetLastShortenedLinks Returns a list of user's shortened links.

func (Utils) GetLinkStats

GetLinkStats Returns stats data for shortened link.

func (Utils) GetServerTime

func (v Utils) GetServerTime() (UtilsGetServerTimeResponse, error)

GetServerTime Returns the current time of the VK server.

func (v Utils) GetShortLink(params UtilsGetShortLinkParams) (*UtilsGetShortLinkResponse, error)

GetShortLink Allows to receive a link shortened via vk.cc.

func (Utils) ResolveScreenName

ResolveScreenName Detects a type of object (e.g., user, community, application) and its ID by screen name.

type UtilsCheckLinkParams

type UtilsCheckLinkParams struct {
	// Link to check (e.g., 'http://google.com').
	URL string `url:"url"`
}

UtilsCheckLinkParams are params for Utils.CheckLink

type UtilsCheckLinkResponse

type UtilsCheckLinkResponse struct {
	// Link status
	Status string `json:"status,omitempty"`
	// Link URL
	Link string `json:"link,omitempty"`
}

UtilsCheckLinkResponse is response for Utils.CheckLink

type UtilsDeleteFromLastShortenedParams

type UtilsDeleteFromLastShortenedParams struct {
	// Link key (characters after vk.cc/).
	Key string `url:"key"`
}

UtilsDeleteFromLastShortenedParams are params for Utils.DeleteFromLastShortened

type UtilsGetLastShortenedLinksParams

type UtilsGetLastShortenedLinksParams struct {
	// Number of links to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of links.
	Offset int `url:"offset,omitempty"`
}

UtilsGetLastShortenedLinksParams are params for Utils.GetLastShortenedLinks

type UtilsGetLastShortenedLinksResponse

type UtilsGetLastShortenedLinksResponse struct {
	// Total number of available results
	Count int `json:"count,omitempty"`
	Items []struct {
		// Creation time in Unixtime
		Timestamp int `json:"timestamp,omitempty"`
		// Full URL
		URL string `json:"url,omitempty"`
		// Short link URL
		ShortURL string `json:"short_url,omitempty"`
		// Link key (characters after vk.cc/)
		Key string `json:"key,omitempty"`
		// Total views number
		Views int `json:"views,omitempty"`
		// Access key for private stats
		AccessKey string `json:"access_key,omitempty"`
	} `json:"items,omitempty"`
}

UtilsGetLastShortenedLinksResponse is response for Utils.GetLastShortenedLinks

type UtilsGetLinkStatsParams

type UtilsGetLinkStatsParams struct {
	// Link key (characters after vk.cc/).
	Key string `url:"key"`
	// Access key for private link stats.
	AccessKey string `url:"access_key,omitempty"`
	// Interval.
	Interval string `url:"interval,omitempty"`
	// Number of intervals to return.
	IntervalsCount int `url:"intervals_count,omitempty"`
	// 1 — to return extended stats data (sex, age, geo). 0 — to return views number only.
	Extended bool `url:"extended,omitempty"`
}

UtilsGetLinkStatsParams are params for Utils.GetLinkStats

type UtilsGetLinkStatsResponse

type UtilsGetLinkStatsResponse interface {
	// contains filtered or unexported methods
}

UtilsGetLinkStatsResponse is response for Utils.GetLinkStats Either UtilsGetLinkStatsResponseNormal or UtilsGetLinkStatsResponseExtended, depending on Extended flag

type UtilsGetLinkStatsResponseExtended

type UtilsGetLinkStatsResponseExtended struct {
	// Link key (characters after vk.cc/)
	Key   string `json:"key,omitempty"`
	Stats []struct {
		// Start time
		Timestamp int `json:"timestamp,omitempty"`
		// Total views number
		Views  int `json:"views,omitempty"`
		SexAge []struct {
			// Age denotation
			AgeRange string `json:"age_range,omitempty"`
			//  Views by female users
			Female int `json:"female,omitempty"`
			//  Views by male users
			Male int `json:"male,omitempty"`
		} `json:"sex_age,omitempty"`
		Countries []struct {
			// Country ID
			CountryID int `json:"country_id,omitempty"`
			// Views number
			Views int `json:"views,omitempty"`
		} `json:"countries,omitempty"`
		Cities []struct {
			// City ID
			CityID int `json:"city_id,omitempty"`
			// Views number
			Views int `json:"views,omitempty"`
		} `json:"cities,omitempty"`
	} `json:"stats,omitempty"`
}

UtilsGetLinkStatsResponseExtended is extended version of UtilsGetLinkStatsResponse

type UtilsGetLinkStatsResponseNormal

type UtilsGetLinkStatsResponseNormal struct {
	// Link key (characters after vk.cc/)
	Key   string `json:"key,omitempty"`
	Stats []struct {
		// Start time
		Timestamp int `json:"timestamp,omitempty"`
		// Total views number
		Views int `json:"views,omitempty"`
	} `json:"stats,omitempty"`
}

UtilsGetLinkStatsResponseNormal is non-extended version of UtilsGetLinkStatsResponse

type UtilsGetServerTimeResponse

type UtilsGetServerTimeResponse int

UtilsGetServerTimeResponse is response for Utils.GetServerTime Time as Unixtime

type UtilsGetShortLinkParams

type UtilsGetShortLinkParams struct {
	// URL to be shortened.
	URL string `url:"url"`
	// 1 — private stats, 0 — public stats.
	Private bool `url:"private,omitempty"`
}

UtilsGetShortLinkParams are params for Utils.GetShortLink

type UtilsGetShortLinkResponse

type UtilsGetShortLinkResponse struct {
	// Short link URL
	ShortURL string `json:"short_url,omitempty"`
	// Access key for private stats
	AccessKey string `json:"access_key,omitempty"`
	// Link key (characters after vk.cc/)
	Key string `json:"key,omitempty"`
	// Full URL
	URL string `json:"url,omitempty"`
}

UtilsGetShortLinkResponse is response for Utils.GetShortLink

type UtilsResolveScreenNameParams

type UtilsResolveScreenNameParams struct {
	// Screen name of the user, community (e.g., 'apiclub,' 'andrew', or 'rules_of_war'), or application.
	ScreenName string `url:"screen_name"`
}

UtilsResolveScreenNameParams are params for Utils.ResolveScreenName

type UtilsResolveScreenNameResponse

type UtilsResolveScreenNameResponse struct {
	// Object type
	Type string `json:"type,omitempty"`
	// Object ID
	ObjectID int `json:"object_id,omitempty"`
}

UtilsResolveScreenNameResponse is response for Utils.ResolveScreenName

type Video

type Video struct {
	API vk.API
}

Video implements VK API namespace `video`

func (Video) Add

func (v Video) Add(params VideoAddParams) (bool, error)

Add Adds a video to a user or community page.

func (Video) AddAlbum

func (v Video) AddAlbum(params VideoAddAlbumParams) (*VideoAddAlbumResponse, error)

AddAlbum Creates an empty album for videos.

func (Video) AddToAlbum

func (v Video) AddToAlbum(params VideoAddToAlbumParams) (bool, error)

AddToAlbum does video.addToAlbum

func (Video) CreateComment

CreateComment Adds a new comment on a video.

func (Video) Delete

func (v Video) Delete(params VideoDeleteParams) (bool, error)

Delete Deletes a video from a user or community page.

func (Video) DeleteAlbum

func (v Video) DeleteAlbum(params VideoDeleteAlbumParams) (bool, error)

DeleteAlbum Deletes a video album.

func (Video) DeleteComment

func (v Video) DeleteComment(params VideoDeleteCommentParams) (bool, error)

DeleteComment Deletes a comment on a video.

func (Video) Edit

func (v Video) Edit(params VideoEditParams) (bool, error)

Edit Edits information about a video on a user or community page.

func (Video) EditAlbum

func (v Video) EditAlbum(params VideoEditAlbumParams) (bool, error)

EditAlbum Edits the title of a video album.

func (Video) EditComment

func (v Video) EditComment(params VideoEditCommentParams) (bool, error)

EditComment Edits the text of a comment on a video.

func (Video) Get

func (v Video) Get(params VideoGetParams) (VideoGetResponse, error)

Get Returns detailed information about videos.

func (Video) GetAlbumByID

func (v Video) GetAlbumByID(params VideoGetAlbumByIDParams) (*VideoGetAlbumByIDResponse, error)

GetAlbumByID Returns video album info

func (Video) GetAlbums

func (v Video) GetAlbums(params VideoGetAlbumsParams) (VideoGetAlbumsResponse, error)

GetAlbums Returns a list of video albums owned by a user or community.

func (Video) GetAlbumsByVideo

GetAlbumsByVideo does video.getAlbumsByVideo

func (Video) GetComments

GetComments Returns a list of comments on a video.

func (Video) RemoveFromAlbum

func (v Video) RemoveFromAlbum(params VideoRemoveFromAlbumParams) (bool, error)

RemoveFromAlbum does video.removeFromAlbum

func (Video) ReorderAlbums

func (v Video) ReorderAlbums(params VideoReorderAlbumsParams) (bool, error)

ReorderAlbums Reorders the album in the list of user video albums.

func (Video) ReorderVideos

func (v Video) ReorderVideos(params VideoReorderVideosParams) (bool, error)

ReorderVideos Reorders the video in the video album.

func (Video) Report

func (v Video) Report(params VideoReportParams) (bool, error)

Report Reports (submits a complaint about) a video.

func (Video) ReportComment

func (v Video) ReportComment(params VideoReportCommentParams) (bool, error)

ReportComment Reports (submits a complaint about) a comment on a video.

func (Video) Restore

func (v Video) Restore(params VideoRestoreParams) (bool, error)

Restore Restores a previously deleted video.

func (Video) RestoreComment

func (v Video) RestoreComment(params VideoRestoreCommentParams) (bool, error)

RestoreComment Restores a previously deleted comment on a video.

func (Video) Save

func (v Video) Save(params VideoSaveParams) (*VideoSaveResponse, error)

Save Returns a server address (required for upload) and video data.

func (Video) Search

func (v Video) Search(params VideoSearchParams) (VideoSearchResponse, error)

Search Returns a list of videos under the set search criterion.

type VideoAddAlbumParams

type VideoAddAlbumParams struct {
	// Community ID (if the album will be created in a community).
	GroupID int `url:"group_id,omitempty"`
	// Album title.
	Title string `url:"title,omitempty"`
	// new access permissions for the album. Possible values: , *'0' – all users,, *'1' – friends only,, *'2' – friends and friends of friends,, *'3' – "only me".
	Privacy CSVStringSlice `url:"privacy,omitempty"`
}

VideoAddAlbumParams are params for Video.AddAlbum

type VideoAddAlbumResponse

type VideoAddAlbumResponse struct {
	// Created album ID
	AlbumID int `json:"album_id,omitempty"`
}

VideoAddAlbumResponse is response for Video.AddAlbum

type VideoAddParams

type VideoAddParams struct {
	// identifier of a user or community to add a video to. Use a negative value to designate a community ID.
	TargetID int `url:"target_id,omitempty"`
	// Video ID.
	VideoID int `url:"video_id"`
	// ID of the user or community that owns the video. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
}

VideoAddParams are params for Video.Add

type VideoAddToAlbumParams

type VideoAddToAlbumParams struct {
	TargetID int         `url:"target_id,omitempty"`
	AlbumID  int         `url:"album_id,omitempty"`
	AlbumIDs CSVIntSlice `url:"album_ids,omitempty"`
	OwnerID  int         `url:"owner_id"`
	VideoID  int         `url:"video_id"`
}

VideoAddToAlbumParams are params for Video.AddToAlbum

type VideoCreateCommentParams

type VideoCreateCommentParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// Video ID.
	VideoID int `url:"video_id"`
	// New comment text.
	Message string `url:"message,omitempty"`
	// List of objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media attachment owner. '<media_id>' — Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// '1' — to post the comment from a community name (only if 'owner_id'<0)
	FromGroup      bool   `url:"from_group,omitempty"`
	ReplyToComment int    `url:"reply_to_comment,omitempty"`
	StickerID      int    `url:"sticker_id,omitempty"`
	GUID           string `url:"guid,omitempty"`
}

VideoCreateCommentParams are params for Video.CreateComment

type VideoCreateCommentResponse

type VideoCreateCommentResponse int

VideoCreateCommentResponse is response for Video.CreateComment Created comment ID

type VideoDeleteAlbumParams

type VideoDeleteAlbumParams struct {
	// Community ID (if the album is owned by a community).
	GroupID int `url:"group_id,omitempty"`
	// Album ID.
	AlbumID int `url:"album_id"`
}

VideoDeleteAlbumParams are params for Video.DeleteAlbum

type VideoDeleteCommentParams

type VideoDeleteCommentParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the comment to be deleted.
	CommentID int `url:"comment_id"`
}

VideoDeleteCommentParams are params for Video.DeleteComment

type VideoDeleteParams

type VideoDeleteParams struct {
	// Video ID.
	VideoID int `url:"video_id"`
	// ID of the user or community that owns the video.
	OwnerID  int `url:"owner_id,omitempty"`
	TargetID int `url:"target_id,omitempty"`
}

VideoDeleteParams are params for Video.Delete

type VideoEditAlbumParams

type VideoEditAlbumParams struct {
	// Community ID (if the album edited is owned by a community).
	GroupID int `url:"group_id,omitempty"`
	// Album ID.
	AlbumID int `url:"album_id"`
	// New album title.
	Title string `url:"title"`
	// new access permissions for the album. Possible values: , *'0' – all users,, *'1' – friends only,, *'2' – friends and friends of friends,, *'3' – "only me".
	Privacy CSVStringSlice `url:"privacy,omitempty"`
}

VideoEditAlbumParams are params for Video.EditAlbum

type VideoEditCommentParams

type VideoEditCommentParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// New comment text.
	Message string `url:"message,omitempty"`
	// List of objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media attachment owner. '<media_id>' — Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

VideoEditCommentParams are params for Video.EditComment

type VideoEditParams

type VideoEditParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// Video ID.
	VideoID int `url:"video_id"`
	// New video title.
	Name string `url:"name,omitempty"`
	// New video description.
	Desc string `url:"desc,omitempty"`
	// Privacy settings in a [vk.com/dev/privacy_setting|special format]. Privacy setting is available for videos uploaded to own profile by user.
	PrivacyView CSVStringSlice `url:"privacy_view,omitempty"`
	// Privacy settings for comments in a [vk.com/dev/privacy_setting|special format].
	PrivacyComment CSVStringSlice `url:"privacy_comment,omitempty"`
	// Disable comments for the group video.
	NoComments bool `url:"no_comments,omitempty"`
	// '1' — to repeat the playback of the video, '0' — to play the video once,
	Repeat bool `url:"repeat,omitempty"`
}

VideoEditParams are params for Video.Edit

type VideoGetAlbumByIDParams

type VideoGetAlbumByIDParams struct {
	// identifier of a user or community to add a video to. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Album ID.
	AlbumID int `url:"album_id"`
}

VideoGetAlbumByIDParams are params for Video.GetAlbumByID

type VideoGetAlbumByIDResponse

type VideoGetAlbumByIDResponse genTODOType /* objects.json#/definitions/video_video_album_full */

VideoGetAlbumByIDResponse is response for Video.GetAlbumByID

type VideoGetAlbumsByVideoParams

type VideoGetAlbumsByVideoParams struct {
	TargetID int  `url:"target_id,omitempty"`
	OwnerID  int  `url:"owner_id"`
	VideoID  int  `url:"video_id"`
	Extended bool `url:"extended,omitempty"`
}

VideoGetAlbumsByVideoParams are params for Video.GetAlbumsByVideo

type VideoGetAlbumsByVideoResponse

type VideoGetAlbumsByVideoResponse interface {
	// contains filtered or unexported methods
}

VideoGetAlbumsByVideoResponse is response for Video.GetAlbumsByVideo Either VideoGetAlbumsByVideoResponseNormal or VideoGetAlbumsByVideoResponseExtended, depending on Extended flag

type VideoGetAlbumsByVideoResponseExtended

type VideoGetAlbumsByVideoResponseExtended struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

VideoGetAlbumsByVideoResponseExtended is extended version of VideoGetAlbumsByVideoResponse

type VideoGetAlbumsByVideoResponseNormal

type VideoGetAlbumsByVideoResponseNormal []int

VideoGetAlbumsByVideoResponseNormal is non-extended version of VideoGetAlbumsByVideoResponse Album ID

type VideoGetAlbumsParams

type VideoGetAlbumsParams struct {
	// ID of the user or community that owns the video album(s).
	OwnerID int `url:"owner_id,omitempty"`
	// Offset needed to return a specific subset of video albums.
	Offset int `url:"offset,omitempty"`
	// Number of video albums to return.
	Count int `url:"count,omitempty"`
	// '1' — to return additional information about album privacy settings for the current user
	Extended   bool `url:"extended,omitempty"`
	NeedSystem bool `url:"need_system,omitempty"`
}

VideoGetAlbumsParams are params for Video.GetAlbums

type VideoGetAlbumsResponse

type VideoGetAlbumsResponse interface {
	// contains filtered or unexported methods
}

VideoGetAlbumsResponse is response for Video.GetAlbums Either VideoGetAlbumsResponseNormal or VideoGetAlbumsResponseExtended, depending on Extended flag

type VideoGetAlbumsResponseExtended

type VideoGetAlbumsResponseExtended struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

VideoGetAlbumsResponseExtended is extended version of VideoGetAlbumsResponse

type VideoGetAlbumsResponseNormal

type VideoGetAlbumsResponseNormal struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Items []genTODOType `json:"items,omitempty"`
}

VideoGetAlbumsResponseNormal is non-extended version of VideoGetAlbumsResponse

type VideoGetCommentsParams

type VideoGetCommentsParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// Video ID.
	VideoID int `url:"video_id"`
	// '1' — to return an additional 'likes' field
	NeedLikes      bool `url:"need_likes,omitempty"`
	StartCommentID int  `url:"start_comment_id,omitempty"`
	// Offset needed to return a specific subset of comments.
	Offset int `url:"offset,omitempty"`
	// Number of comments to return.
	Count int `url:"count,omitempty"`
	// Sort order: 'asc' — oldest comment first, 'desc' — newest comment first
	Sort     string         `url:"sort,omitempty"`
	Extended bool           `url:"extended,omitempty"`
	Fields   CSVStringSlice `url:"fields,omitempty"`
}

VideoGetCommentsParams are params for Video.GetComments

type VideoGetCommentsResponse

type VideoGetCommentsResponse interface {
	// contains filtered or unexported methods
}

VideoGetCommentsResponse is response for Video.GetComments Either VideoGetCommentsResponseNormal or VideoGetCommentsResponseExtended, depending on Extended flag

type VideoGetCommentsResponseExtended

type VideoGetCommentsResponseExtended struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Comment `json:"items,omitempty"`
}

VideoGetCommentsResponseExtended is extended version of VideoGetCommentsResponse

type VideoGetCommentsResponseNormal

type VideoGetCommentsResponseNormal struct {
	// Total number
	Count    int          `json:"count,omitempty"`
	Items    []vk.Comment `json:"items,omitempty"`
	Profiles []vk.User    `json:"profiles,omitempty"`
	Groups   []vk.Group   `json:"groups,omitempty"`
}

VideoGetCommentsResponseNormal is non-extended version of VideoGetCommentsResponse

type VideoGetParams

type VideoGetParams struct {
	// ID of the user or community that owns the video(s).
	OwnerID int `url:"owner_id,omitempty"`
	// Video IDs, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", Use a negative value to designate a community ID. Example: "-4363_136089719,13245770_137352259"
	Videos CSVStringSlice `url:"videos,omitempty"`
	// ID of the album containing the video(s).
	AlbumID int `url:"album_id,omitempty"`
	// Number of videos to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of videos.
	Offset int `url:"offset,omitempty"`
	// '1' — to return an extended response with additional fields
	Extended bool `url:"extended,omitempty"`
}

VideoGetParams are params for Video.Get

type VideoGetResponse

type VideoGetResponse interface {
	// contains filtered or unexported methods
}

VideoGetResponse is response for Video.Get Either VideoGetResponseNormal or VideoGetResponseExtended, depending on Extended flag

type VideoGetResponseExtended

type VideoGetResponseExtended struct {
	// Total number
	Count    int        `json:"count,omitempty"`
	Items    []vk.Video `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

VideoGetResponseExtended is extended version of VideoGetResponse

type VideoGetResponseNormal

type VideoGetResponseNormal struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Video `json:"items,omitempty"`
}

VideoGetResponseNormal is non-extended version of VideoGetResponse

type VideoRemoveFromAlbumParams

type VideoRemoveFromAlbumParams struct {
	TargetID int         `url:"target_id,omitempty"`
	AlbumID  int         `url:"album_id,omitempty"`
	AlbumIDs CSVIntSlice `url:"album_ids,omitempty"`
	OwnerID  int         `url:"owner_id"`
	VideoID  int         `url:"video_id"`
}

VideoRemoveFromAlbumParams are params for Video.RemoveFromAlbum

type VideoReorderAlbumsParams

type VideoReorderAlbumsParams struct {
	// ID of the user or community that owns the albums..
	OwnerID int `url:"owner_id,omitempty"`
	// Album ID.
	AlbumID int `url:"album_id"`
	// ID of the album before which the album in question shall be placed.
	Before int `url:"before,omitempty"`
	// ID of the album after which the album in question shall be placed.
	After int `url:"after,omitempty"`
}

VideoReorderAlbumsParams are params for Video.ReorderAlbums

type VideoReorderVideosParams

type VideoReorderVideosParams struct {
	// ID of the user or community that owns the album with videos.
	TargetID int `url:"target_id,omitempty"`
	// ID of the video album.
	AlbumID int `url:"album_id,omitempty"`
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id"`
	// ID of the video.
	VideoID int `url:"video_id"`
	// ID of the user or community that owns the video before which the video in question shall be placed.
	BeforeOwnerID int `url:"before_owner_id,omitempty"`
	// ID of the video before which the video in question shall be placed.
	BeforeVideoID int `url:"before_video_id,omitempty"`
	// ID of the user or community that owns the video after which the photo in question shall be placed.
	AfterOwnerID int `url:"after_owner_id,omitempty"`
	// ID of the video after which the photo in question shall be placed.
	AfterVideoID int `url:"after_video_id,omitempty"`
}

VideoReorderVideosParams are params for Video.ReorderVideos

type VideoReportCommentParams

type VideoReportCommentParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id"`
	// ID of the comment being reported.
	CommentID int `url:"comment_id"`
	// Reason for the complaint: , 0 – spam , 1 – child pornography , 2 – extremism , 3 – violence , 4 – drug propaganda , 5 – adult material , 6 – insult, abuse
	Reason int `url:"reason,omitempty"`
}

VideoReportCommentParams are params for Video.ReportComment

type VideoReportParams

type VideoReportParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id"`
	// Video ID.
	VideoID int `url:"video_id"`
	// Reason for the complaint: '0' – spam, '1' – child pornography, '2' – extremism, '3' – violence, '4' – drug propaganda, '5' – adult material, '6' – insult, abuse
	Reason int `url:"reason,omitempty"`
	// Comment describing the complaint.
	Comment string `url:"comment,omitempty"`
	// (If the video was found in search results.) Search query string.
	SearchQuery string `url:"search_query,omitempty"`
}

VideoReportParams are params for Video.Report

type VideoRestoreCommentParams

type VideoRestoreCommentParams struct {
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the deleted comment.
	CommentID int `url:"comment_id"`
}

VideoRestoreCommentParams are params for Video.RestoreComment

type VideoRestoreParams

type VideoRestoreParams struct {
	// Video ID.
	VideoID int `url:"video_id"`
	// ID of the user or community that owns the video.
	OwnerID int `url:"owner_id,omitempty"`
}

VideoRestoreParams are params for Video.Restore

type VideoSaveParams

type VideoSaveParams struct {
	// Name of the video.
	Name string `url:"name,omitempty"`
	// Description of the video.
	Description string `url:"description,omitempty"`
	// '1' — to designate the video as private (send it via a private message), the video will not appear on the user's video list and will not be available by ID for other users, '0' — not to designate the video as private
	IsPrivate bool `url:"is_private,omitempty"`
	// '1' — to post the saved video on a user's wall, '0' — not to post the saved video on a user's wall
	Wallpost bool `url:"wallpost,omitempty"`
	// URL for embedding the video from an external website.
	Link string `url:"link,omitempty"`
	// ID of the community in which the video will be saved. By default, the current user's page.
	GroupID int `url:"group_id,omitempty"`
	// ID of the album to which the saved video will be added.
	AlbumID        int            `url:"album_id,omitempty"`
	PrivacyView    CSVStringSlice `url:"privacy_view,omitempty"`
	PrivacyComment CSVStringSlice `url:"privacy_comment,omitempty"`
	NoComments     bool           `url:"no_comments,omitempty"`
	// '1' — to repeat the playback of the video, '0' — to play the video once,
	Repeat      bool `url:"repeat,omitempty"`
	Compression bool `url:"compression,omitempty"`
}

VideoSaveParams are params for Video.Save

type VideoSaveResponse

type VideoSaveResponse struct {
	// URL for the video uploading
	UploadURL string `json:"upload_url,omitempty"`
	// Video ID
	VideoID int `json:"video_id,omitempty"`
	// Video owner ID
	OwnerID int `json:"owner_id,omitempty"`
	// Video title
	Title string `json:"title,omitempty"`
	// Video description
	Description string `json:"description,omitempty"`
}

VideoSaveResponse is response for Video.Save

type VideoSearchParams

type VideoSearchParams struct {
	// Search query string (e.g., 'The Beatles').
	Q string `url:"q"`
	// Sort order: '1' — by duration, '2' — by relevance, '0' — by date added
	Sort int `url:"sort,omitempty"`
	// If not null, only searches for high-definition videos.
	Hd int `url:"hd,omitempty"`
	// '1' — to disable the Safe Search filter, '0' — to enable the Safe Search filter
	Adult bool `url:"adult,omitempty"`
	// Filters to apply: 'youtube' — return YouTube videos only, 'vimeo' — return Vimeo videos only, 'short' — return short videos only, 'long' — return long videos only
	Filters   CSVStringSlice `url:"filters,omitempty"`
	SearchOwn bool           `url:"search_own,omitempty"`
	// Offset needed to return a specific subset of videos.
	Offset  int `url:"offset,omitempty"`
	Longer  int `url:"longer,omitempty"`
	Shorter int `url:"shorter,omitempty"`
	// Number of videos to return.
	Count    int  `url:"count,omitempty"`
	Extended bool `url:"extended,omitempty"`
}

VideoSearchParams are params for Video.Search

type VideoSearchResponse

type VideoSearchResponse interface {
	// contains filtered or unexported methods
}

VideoSearchResponse is response for Video.Search Either VideoSearchResponseNormal or VideoSearchResponseExtended, depending on Extended flag

type VideoSearchResponseExtended

type VideoSearchResponseExtended struct {
	// Total number
	Count    int        `json:"count,omitempty"`
	Items    []vk.Video `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

VideoSearchResponseExtended is extended version of VideoSearchResponse

type VideoSearchResponseNormal

type VideoSearchResponseNormal struct {
	// Total number
	Count int        `json:"count,omitempty"`
	Items []vk.Video `json:"items,omitempty"`
}

VideoSearchResponseNormal is non-extended version of VideoSearchResponse

type Wall

type Wall struct {
	API vk.API
}

Wall implements VK API namespace `wall`

func (Wall) CloseComments

func (v Wall) CloseComments(params WallCloseCommentsParams) (bool, error)

CloseComments does wall.closeComments

func (Wall) CreateComment

func (v Wall) CreateComment(params WallCreateCommentParams) (*WallCreateCommentResponse, error)

CreateComment Adds a comment to a post on a user wall or community wall.

func (Wall) Delete

func (v Wall) Delete(params WallDeleteParams) (bool, error)

Delete Deletes a post from a user wall or community wall.

func (Wall) DeleteComment

func (v Wall) DeleteComment(params WallDeleteCommentParams) (bool, error)

DeleteComment Deletes a comment on a post on a user wall or community wall.

func (Wall) Edit

func (v Wall) Edit(params WallEditParams) (bool, error)

Edit Edits a post on a user wall or community wall.

func (Wall) EditAdsStealth

func (v Wall) EditAdsStealth(params WallEditAdsStealthParams) (bool, error)

EditAdsStealth Allows to edit hidden post.

func (Wall) EditComment

func (v Wall) EditComment(params WallEditCommentParams) (bool, error)

EditComment Edits a comment on a user wall or community wall.

func (Wall) Get

func (v Wall) Get(params WallGetParams) (WallGetResponse, error)

Get Returns a list of posts on a user wall or community wall.

func (Wall) GetByID

func (v Wall) GetByID(params WallGetByIDParams) (WallGetByIDResponse, error)

GetByID Returns a list of posts from user or community walls by their IDs.

func (Wall) GetComments

func (v Wall) GetComments(params WallGetCommentsParams) (WallGetCommentsResponse, error)

GetComments Returns a list of comments on a post on a user wall or community wall.

func (Wall) GetReposts

func (v Wall) GetReposts(params WallGetRepostsParams) (*WallGetRepostsResponse, error)

GetReposts Returns information about reposts of a post on user wall or community wall.

func (Wall) OpenComments

func (v Wall) OpenComments(params WallOpenCommentsParams) (bool, error)

OpenComments does wall.openComments

func (Wall) Pin

func (v Wall) Pin(params WallPinParams) (bool, error)

Pin Pins the post on wall.

func (Wall) Post

func (v Wall) Post(params WallPostParams) (*WallPostResponse, error)

Post Adds a new post on a user wall or community wall. Can also be used to publish suggested or scheduled posts.

func (Wall) PostAdsStealth

func (v Wall) PostAdsStealth(params WallPostAdsStealthParams) (*WallPostAdsStealthResponse, error)

PostAdsStealth Allows to create hidden post which will not be shown on the community's wall and can be used for creating an ad with type "Community post".

func (Wall) ReportComment

func (v Wall) ReportComment(params WallReportCommentParams) (bool, error)

ReportComment Reports (submits a complaint about) a comment on a post on a user wall or community wall.

func (Wall) ReportPost

func (v Wall) ReportPost(params WallReportPostParams) (bool, error)

ReportPost Reports (submits a complaint about) a post on a user wall or community wall.

func (Wall) Repost

func (v Wall) Repost(params WallRepostParams) (*WallRepostResponse, error)

Repost Reposts (copies) an object to a user wall or community wall.

func (Wall) Restore

func (v Wall) Restore(params WallRestoreParams) (bool, error)

Restore Restores a post deleted from a user wall or community wall.

func (Wall) RestoreComment

func (v Wall) RestoreComment(params WallRestoreCommentParams) (bool, error)

RestoreComment Restores a comment deleted from a user wall or community wall.

func (Wall) Search

func (v Wall) Search(params WallSearchParams) (WallSearchResponse, error)

Search Allows to search posts on user or community walls.

func (Wall) Unpin

func (v Wall) Unpin(params WallUnpinParams) (bool, error)

Unpin Unpins the post on wall.

type WallCloseCommentsParams

type WallCloseCommentsParams struct {
	OwnerID int `url:"owner_id"`
	PostID  int `url:"post_id"`
}

WallCloseCommentsParams are params for Wall.CloseComments

type WallCreateCommentParams

type WallCreateCommentParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID.
	PostID int `url:"post_id"`
	// Group ID.
	FromGroup int `url:"from_group,omitempty"`
	// (Required if 'attachments' is not set.) Text of the comment.
	Message string `url:"message,omitempty"`
	// ID of comment to reply.
	ReplyToComment int `url:"reply_to_comment,omitempty"`
	// (Required if 'message' is not set.) List of media objects attached to the comment, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media ojbect: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media owner. '<media_id>' — Media ID. For example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// Sticker ID.
	StickerID int `url:"sticker_id,omitempty"`
	// Unique identifier to avoid repeated comments.
	GUID string `url:"guid,omitempty"`
}

WallCreateCommentParams are params for Wall.CreateComment

type WallCreateCommentResponse

type WallCreateCommentResponse struct {
	// Created comment ID
	CommentID int `json:"comment_id,omitempty"`
}

WallCreateCommentResponse is response for Wall.CreateComment

type WallDeleteCommentParams

type WallDeleteCommentParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
}

WallDeleteCommentParams are params for Wall.DeleteComment

type WallDeleteParams

type WallDeleteParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the post to be deleted.
	PostID int `url:"post_id,omitempty"`
}

WallDeleteParams are params for Wall.Delete

type WallEditAdsStealthParams

type WallEditAdsStealthParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID. Used for publishing of scheduled and suggested posts.
	PostID int `url:"post_id"`
	// (Required if 'attachments' is not set.) Text of the post.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'page' — wiki-page, 'note' — note, 'poll' — poll, 'album' — photo album, '<owner_id>' — ID of the media application owner. '<media_id>' — Media application ID. Example: "photo100172_166443618,photo66748_265827614", May contain a link to an external page to include in the post. Example: "photo66748_265827614,http://habrahabr.ru", "NOTE: If more than one link is being attached, an error will be thrown."
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// Only for posts in communities with 'from_group' set to '1': '1' — post will be signed with the name of the posting user, '0' — post will not be signed (default)
	Signed bool `url:"signed,omitempty"`
	// Geographical latitude of a check-in, in degrees (from -90 to 90).
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude of a check-in, in degrees (from -180 to 180).
	Long float32 `url:"long,omitempty"`
	// ID of the location where the user was tagged.
	PlaceID int `url:"place_id,omitempty"`
	// Link button ID
	LinkButton string `url:"link_button,omitempty"`
	// Link title
	LinkTitle string `url:"link_title,omitempty"`
	// Link image url
	LinkImage string `url:"link_image,omitempty"`
}

WallEditAdsStealthParams are params for Wall.EditAdsStealth

type WallEditCommentParams

type WallEditCommentParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// New comment text.
	Message string `url:"message,omitempty"`
	// List of objects attached to the comment, in the following format: , "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media attachment owner. '<media_id>' — Media attachment ID. For example: "photo100172_166443618,photo66748_265827614"
	Attachments CSVStringSlice `url:"attachments,omitempty"`
}

WallEditCommentParams are params for Wall.EditComment

type WallEditParams

type WallEditParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID     int  `url:"owner_id,omitempty"`
	PostID      int  `url:"post_id"`
	FriendsOnly bool `url:"friends_only,omitempty"`
	// (Required if 'attachments' is not set.) Text of the post.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '<owner_id>' — ID of the media application owner. '<media_id>' — Media application ID. Example: "photo100172_166443618,photo66748_265827614", May contain a link to an external page to include in the post. Example: "photo66748_265827614,http://habrahabr.ru", "NOTE: If more than one link is being attached, an error is thrown."
	Attachments   CSVStringSlice `url:"attachments,omitempty"`
	Services      string         `url:"services,omitempty"`
	Signed        bool           `url:"signed,omitempty"`
	PublishDate   int            `url:"publish_date,omitempty"`
	Lat           float32        `url:"lat,omitempty"`
	Long          float32        `url:"long,omitempty"`
	PlaceID       int            `url:"place_id,omitempty"`
	MarkAsAds     bool           `url:"mark_as_ads,omitempty"`
	CloseComments bool           `url:"close_comments,omitempty"`
	PosterBkgID   int            `url:"poster_bkg_id,omitempty"`
}

WallEditParams are params for Wall.Edit

type WallGetByIDParams

type WallGetByIDParams struct {
	// User or community IDs and post IDs, separated by underscores. Use a negative value to designate a community ID. Example: "93388_21539,93388_20904,2943_4276,-1_1"
	Posts CSVStringSlice `url:"posts"`
	// '1' — to return user and community objects needed to display posts, '0' — no additional fields are returned (default)
	Extended bool `url:"extended,omitempty"`
	// Sets the number of parent elements to include in the array 'copy_history' that is returned if the post is a repost from another wall.
	CopyHistoryDepth int            `url:"copy_history_depth,omitempty"`
	Fields           CSVStringSlice `url:"fields,omitempty"`
}

WallGetByIDParams are params for Wall.GetByID

type WallGetByIDResponse

type WallGetByIDResponse interface {
	// contains filtered or unexported methods
}

WallGetByIDResponse is response for Wall.GetByID Either WallGetByIDResponseNormal or WallGetByIDResponseExtended, depending on Extended flag

type WallGetByIDResponseExtended

type WallGetByIDResponseExtended struct {
	Items    []vk.Post  `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

WallGetByIDResponseExtended is extended version of WallGetByIDResponse

type WallGetByIDResponseNormal

type WallGetByIDResponseNormal []vk.Post

WallGetByIDResponseNormal is non-extended version of WallGetByIDResponse

type WallGetCommentsParams

type WallGetCommentsParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID.
	PostID int `url:"post_id,omitempty"`
	// '1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)
	NeedLikes      bool `url:"need_likes,omitempty"`
	StartCommentID int  `url:"start_comment_id,omitempty"`
	// Offset needed to return a specific subset of comments.
	Offset int `url:"offset,omitempty"`
	// Number of comments to return (maximum 100).
	Count int `url:"count,omitempty"`
	// Sort order: 'asc' — chronological, 'desc' — reverse chronological
	Sort string `url:"sort,omitempty"`
	// Number of characters at which to truncate comments when previewed. By default, '90'. Specify '0' if you do not want to truncate comments.
	PreviewLength int            `url:"preview_length,omitempty"`
	Extended      bool           `url:"extended,omitempty"`
	Fields        CSVStringSlice `url:"fields,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id,omitempty"`
	// Count items in threads.
	ThreadItemsCount int `url:"thread_items_count,omitempty"`
}

WallGetCommentsParams are params for Wall.GetComments

type WallGetCommentsResponse

type WallGetCommentsResponse interface {
	// contains filtered or unexported methods
}

WallGetCommentsResponse is response for Wall.GetComments Either WallGetCommentsResponseNormal or WallGetCommentsResponseExtended, depending on Extended flag

type WallGetCommentsResponseExtended

type WallGetCommentsResponseExtended struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Comment `json:"items,omitempty"`
	// Information whether current user can comment the post
	CanPost vk.BoolInt `json:"can_post,omitempty"`
	// Information whether groups can comment the post
	GroupsCanPost bool `json:"groups_can_post,omitempty"`
	// Count of replies of current level
	CurrentLevelCount int        `json:"current_level_count,omitempty"`
	Profiles          []vk.User  `json:"profiles,omitempty"`
	Groups            []vk.Group `json:"groups,omitempty"`
}

WallGetCommentsResponseExtended is extended version of WallGetCommentsResponse

type WallGetCommentsResponseNormal

type WallGetCommentsResponseNormal struct {
	// Total number
	Count int          `json:"count,omitempty"`
	Items []vk.Comment `json:"items,omitempty"`
	// Information whether current user can comment the post
	CanPost vk.BoolInt `json:"can_post,omitempty"`
	// Information whether groups can comment the post
	GroupsCanPost bool `json:"groups_can_post,omitempty"`
	// Count of replies of current level
	CurrentLevelCount int `json:"current_level_count,omitempty"`
}

WallGetCommentsResponseNormal is non-extended version of WallGetCommentsResponse

type WallGetParams

type WallGetParams struct {
	// ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// User or community short address.
	Domain string `url:"domain,omitempty"`
	// Offset needed to return a specific subset of posts.
	Offset int `url:"offset,omitempty"`
	// Number of posts to return (maximum 100).
	Count int `url:"count,omitempty"`
	// Filter to apply: 'owner' — posts by the wall owner, 'others' — posts by someone else, 'all' — posts by the wall owner and others (default), 'postponed' — timed posts (only available for calls with an 'access_token'), 'suggests' — suggested posts on a community wall
	Filter string `url:"filter,omitempty"`
	// '1' — to return 'wall', 'profiles', and 'groups' fields, '0' — to return no additional fields (default)
	Extended bool           `url:"extended,omitempty"`
	Fields   CSVStringSlice `url:"fields,omitempty"`
}

WallGetParams are params for Wall.Get

type WallGetRepostsParams

type WallGetRepostsParams struct {
	// User ID or community ID. By default, current user ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID.
	PostID int `url:"post_id,omitempty"`
	// Offset needed to return a specific subset of reposts.
	Offset int `url:"offset,omitempty"`
	// Number of reposts to return.
	Count int `url:"count,omitempty"`
}

WallGetRepostsParams are params for Wall.GetReposts

type WallGetRepostsResponse

type WallGetRepostsResponse struct {
	Items    []vk.Post  `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

WallGetRepostsResponse is response for Wall.GetReposts

type WallGetResponse

type WallGetResponse interface {
	// contains filtered or unexported methods
}

WallGetResponse is response for Wall.Get Either WallGetResponseNormal or WallGetResponseExtended, depending on Extended flag

type WallGetResponseExtended

type WallGetResponseExtended struct {
	// Total number
	Count    int        `json:"count,omitempty"`
	Items    []vk.Post  `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

WallGetResponseExtended is extended version of WallGetResponse

type WallGetResponseNormal

type WallGetResponseNormal struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Post `json:"items,omitempty"`
}

WallGetResponseNormal is non-extended version of WallGetResponse

type WallOpenCommentsParams

type WallOpenCommentsParams struct {
	OwnerID int `url:"owner_id"`
	PostID  int `url:"post_id"`
}

WallOpenCommentsParams are params for Wall.OpenComments

type WallPinParams

type WallPinParams struct {
	// ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID.
	PostID int `url:"post_id"`
}

WallPinParams are params for Wall.Pin

type WallPostAdsStealthParams

type WallPostAdsStealthParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id"`
	// (Required if 'attachments' is not set.) Text of the post.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'page' — wiki-page, 'note' — note, 'poll' — poll, 'album' — photo album, '<owner_id>' — ID of the media application owner. '<media_id>' — Media application ID. Example: "photo100172_166443618,photo66748_265827614", May contain a link to an external page to include in the post. Example: "photo66748_265827614,http://habrahabr.ru", "NOTE: If more than one link is being attached, an error will be thrown."
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// Only for posts in communities with 'from_group' set to '1': '1' — post will be signed with the name of the posting user, '0' — post will not be signed (default)
	Signed bool `url:"signed,omitempty"`
	// Geographical latitude of a check-in, in degrees (from -90 to 90).
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude of a check-in, in degrees (from -180 to 180).
	Long float32 `url:"long,omitempty"`
	// ID of the location where the user was tagged.
	PlaceID int `url:"place_id,omitempty"`
	// Unique identifier to avoid duplication the same post.
	GUID string `url:"guid,omitempty"`
	// Link button ID
	LinkButton string `url:"link_button,omitempty"`
	// Link title
	LinkTitle string `url:"link_title,omitempty"`
	// Link image url
	LinkImage string `url:"link_image,omitempty"`
}

WallPostAdsStealthParams are params for Wall.PostAdsStealth

type WallPostAdsStealthResponse

type WallPostAdsStealthResponse struct {
	// Created post ID
	PostID int `json:"post_id,omitempty"`
}

WallPostAdsStealthResponse is response for Wall.PostAdsStealth

type WallPostParams

type WallPostParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// '1' — post will be available to friends only, '0' — post will be available to all users (default)
	FriendsOnly bool `url:"friends_only,omitempty"`
	// For a community: '1' — post will be published by the community, '0' — post will be published by the user (default)
	FromGroup bool `url:"from_group,omitempty"`
	// (Required if 'attachments' is not set.) Text of the post.
	Message string `url:"message,omitempty"`
	// (Required if 'message' is not set.) List of objects attached to the post, in the following format: "<owner_id>_<media_id>,<owner_id>_<media_id>", ” — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'page' — wiki-page, 'note' — note, 'poll' — poll, 'album' — photo album, '<owner_id>' — ID of the media application owner. '<media_id>' — Media application ID. Example: "photo100172_166443618,photo66748_265827614", May contain a link to an external page to include in the post. Example: "photo66748_265827614,http://habrahabr.ru", "NOTE: If more than one link is being attached, an error will be thrown."
	Attachments CSVStringSlice `url:"attachments,omitempty"`
	// List of services or websites the update will be exported to, if the user has so requested. Sample values: 'twitter', 'facebook'.
	Services string `url:"services,omitempty"`
	// Only for posts in communities with 'from_group' set to '1': '1' — post will be signed with the name of the posting user, '0' — post will not be signed (default)
	Signed bool `url:"signed,omitempty"`
	// Publication date (in Unix time). If used, posting will be delayed until the set time.
	PublishDate int `url:"publish_date,omitempty"`
	// Geographical latitude of a check-in, in degrees (from -90 to 90).
	Lat float32 `url:"lat,omitempty"`
	// Geographical longitude of a check-in, in degrees (from -180 to 180).
	Long float32 `url:"long,omitempty"`
	// ID of the location where the user was tagged.
	PlaceID int `url:"place_id,omitempty"`
	// Post ID. Used for publishing of scheduled and suggested posts.
	PostID        int    `url:"post_id,omitempty"`
	GUID          string `url:"guid,omitempty"`
	MarkAsAds     bool   `url:"mark_as_ads,omitempty"`
	CloseComments bool   `url:"close_comments,omitempty"`
}

WallPostParams are params for Wall.Post

type WallPostResponse

type WallPostResponse struct {
	// Created post ID
	PostID int `json:"post_id,omitempty"`
}

WallPostResponse is response for Wall.Post

type WallReportCommentParams

type WallReportCommentParams struct {
	// ID of the user or community that owns the wall.
	OwnerID int `url:"owner_id"`
	// Comment ID.
	CommentID int `url:"comment_id"`
	// Reason for the complaint: '0' – spam, '1' – child pornography, '2' – extremism, '3' – violence, '4' – drug propaganda, '5' – adult material, '6' – insult, abuse
	Reason int `url:"reason,omitempty"`
}

WallReportCommentParams are params for Wall.ReportComment

type WallReportPostParams

type WallReportPostParams struct {
	// ID of the user or community that owns the wall.
	OwnerID int `url:"owner_id"`
	// Post ID.
	PostID int `url:"post_id"`
	// Reason for the complaint: '0' – spam, '1' – child pornography, '2' – extremism, '3' – violence, '4' – drug propaganda, '5' – adult material, '6' – insult, abuse
	Reason int `url:"reason,omitempty"`
}

WallReportPostParams are params for Wall.ReportPost

type WallRepostParams

type WallRepostParams struct {
	// ID of the object to be reposted on the wall. Example: "wall66748_3675"
	Object string `url:"object"`
	// Comment to be added along with the reposted object.
	Message string `url:"message,omitempty"`
	// Target community ID when reposting to a community.
	GroupID   int  `url:"group_id,omitempty"`
	MarkAsAds bool `url:"mark_as_ads,omitempty"`
}

WallRepostParams are params for Wall.Repost

type WallRepostResponse

type WallRepostResponse struct {
	Success vk.BoolInt `json:"success,omitempty"`
	// Created post ID
	PostID int `json:"post_id,omitempty"`
	// Reposts number
	RepostsCount int `json:"reposts_count,omitempty"`
	// Reposts number
	LikesCount int `json:"likes_count,omitempty"`
}

WallRepostResponse is response for Wall.Repost

type WallRestoreCommentParams

type WallRestoreCommentParams struct {
	// User ID or community ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Comment ID.
	CommentID int `url:"comment_id"`
}

WallRestoreCommentParams are params for Wall.RestoreComment

type WallRestoreParams

type WallRestoreParams struct {
	// User ID or community ID from whose wall the post was deleted. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// ID of the post to be restored.
	PostID int `url:"post_id,omitempty"`
}

WallRestoreParams are params for Wall.Restore

type WallSearchParams

type WallSearchParams struct {
	// user or community id. "Remember that for a community 'owner_id' must be negative."
	OwnerID int `url:"owner_id,omitempty"`
	// user or community screen name.
	Domain string `url:"domain,omitempty"`
	// search query string.
	Query string `url:"query,omitempty"`
	// '1' – returns only page owner's posts.
	OwnersOnly bool `url:"owners_only,omitempty"`
	// count of posts to return.
	Count int `url:"count,omitempty"`
	// Offset needed to return a specific subset of posts.
	Offset int `url:"offset,omitempty"`
	// show extended post info.
	Extended bool           `url:"extended,omitempty"`
	Fields   CSVStringSlice `url:"fields,omitempty"`
}

WallSearchParams are params for Wall.Search

type WallSearchResponse

type WallSearchResponse interface {
	// contains filtered or unexported methods
}

WallSearchResponse is response for Wall.Search Either WallSearchResponseNormal or WallSearchResponseExtended, depending on Extended flag

type WallSearchResponseExtended

type WallSearchResponseExtended struct {
	// Total number
	Count    int        `json:"count,omitempty"`
	Items    []vk.Post  `json:"items,omitempty"`
	Profiles []vk.User  `json:"profiles,omitempty"`
	Groups   []vk.Group `json:"groups,omitempty"`
}

WallSearchResponseExtended is extended version of WallSearchResponse

type WallSearchResponseNormal

type WallSearchResponseNormal struct {
	// Total number
	Count int       `json:"count,omitempty"`
	Items []vk.Post `json:"items,omitempty"`
}

WallSearchResponseNormal is non-extended version of WallSearchResponse

type WallUnpinParams

type WallUnpinParams struct {
	// ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.
	OwnerID int `url:"owner_id,omitempty"`
	// Post ID.
	PostID int `url:"post_id"`
}

WallUnpinParams are params for Wall.Unpin

type Widgets

type Widgets struct {
	API vk.API
}

Widgets implements VK API namespace `widgets`

func (Widgets) GetComments

GetComments Gets a list of comments for the page added through the [vk.com/dev/Comments|Comments widget].

func (Widgets) GetPages

GetPages Gets a list of application/site pages where the [vk.com/dev/Comments|Comments widget] or [vk.com/dev/Like|Like widget] is installed.

type WidgetsGetCommentsParams

type WidgetsGetCommentsParams struct {
	WidgetAPIID int            `url:"widget_api_id,omitempty"`
	URL         string         `url:"url,omitempty"`
	PageID      string         `url:"page_id,omitempty"`
	Order       string         `url:"order,omitempty"`
	Fields      CSVStringSlice `url:"fields,omitempty"`
	Offset      int            `url:"offset,omitempty"`
	Count       int            `url:"count,omitempty"`
}

WidgetsGetCommentsParams are params for Widgets.GetComments

type WidgetsGetCommentsResponse

type WidgetsGetCommentsResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Posts []genTODOType `json:"posts,omitempty"`
}

WidgetsGetCommentsResponse is response for Widgets.GetComments

type WidgetsGetPagesParams

type WidgetsGetPagesParams struct {
	WidgetAPIID int    `url:"widget_api_id,omitempty"`
	Order       string `url:"order,omitempty"`
	Period      string `url:"period,omitempty"`
	Offset      int    `url:"offset,omitempty"`
	Count       int    `url:"count,omitempty"`
}

WidgetsGetPagesParams are params for Widgets.GetPages

type WidgetsGetPagesResponse

type WidgetsGetPagesResponse struct {
	// Total number
	Count int           `json:"count,omitempty"`
	Pages []genTODOType `json:"pages,omitempty"`
}

WidgetsGetPagesResponse is response for Widgets.GetPages

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL