Package com.vk.api.sdk.queries.messages

Class MessagesGetInviteLinkQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetInviteLinkQuery,GetInviteLinkResponse>

com.vk.api.sdk.queries.messages.MessagesGetInviteLinkQuery

public class MessagesGetInviteLinkQuery
extends AbstractQueryBuilder<MessagesGetInviteLinkQuery,GetInviteLinkResponse>

Query for Messages.getInviteLink method

Constructor Summary

Constructors

Constructor	Description
MessagesGetInviteLinkQuery(VkApiClient client, GroupActor actor, int peerId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesGetInviteLinkQuery(VkApiClient client, UserActor actor, int peerId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected MessagesGetInviteLinkQuery	getThis()	Get reference to this object
MessagesGetInviteLinkQuery	groupId(java.lang.Integer value)	Group ID
protected MessagesGetInviteLinkQuery	peerId(int value)	Destination ID.
MessagesGetInviteLinkQuery	reset(java.lang.Boolean value)	1 — to generate new link (revoke previous), 0 — to return previous link.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessagesGetInviteLinkQuery

public MessagesGetInviteLinkQuery(VkApiClient client,
                                  UserActor actor,
                                  int peerId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

peerId - value of "peer id" parameter. Minimum is 0.

MessagesGetInviteLinkQuery

public MessagesGetInviteLinkQuery(VkApiClient client,
                                  GroupActor actor,
                                  int peerId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

peerId - value of "peer id" parameter. Minimum is 0.

Method Detail

peerId

protected MessagesGetInviteLinkQuery peerId(int value)

Destination ID.

Parameters:

value - value of "peer id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

reset

public MessagesGetInviteLinkQuery reset(java.lang.Boolean value)

1 — to generate new link (revoke previous), 0 — to return previous link.

Parameters:

value - value of "reset" parameter. By default false.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

groupId

public MessagesGetInviteLinkQuery groupId(java.lang.Integer value)

Group ID

Parameters:

value - value of "group id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected MessagesGetInviteLinkQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetInviteLinkQuery,GetInviteLinkResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<MessagesGetInviteLinkQuery,GetInviteLinkResponse>

Returns:

list of names