MessagesSendQueryWithUserIds (sdk 1.0.15 API)

java.lang.Object
- com.vk.api.sdk.client.ApiRequest<R>
- - com.vk.api.sdk.client.AbstractQueryBuilder<MessagesSendQueryWithUserIds,java.util.List<SendUserIdsResponse>>
  - - com.vk.api.sdk.queries.messages.MessagesSendQueryWithUserIds

public class MessagesSendQueryWithUserIds
extends AbstractQueryBuilder<MessagesSendQueryWithUserIds,java.util.List<SendUserIdsResponse>>

Query for Messages.send method

Constructor Summary

Constructors
Constructor and Description
`MessagesSendQueryWithUserIds(VkApiClient client, GroupActor actor)` Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
`MessagesSendQueryWithUserIds(VkApiClient client, UserActor actor)` Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessagesSendQueryWithUserIds`	`attachment(java.lang.String value)` (Required if 'message' is not set.)
`MessagesSendQueryWithUserIds`	`chatId(java.lang.Integer value)` ID of conversation the message will relate to.
`MessagesSendQueryWithUserIds`	`contentSource(java.lang.String value)` JSON describing the content source in the message
`MessagesSendQueryWithUserIds`	`disableMentions(java.lang.Boolean value)` Set disable mentions
`MessagesSendQueryWithUserIds`	`domain(java.lang.String value)` User's short address (for example, 'illarionov').
`MessagesSendQueryWithUserIds`	`dontParseLinks(java.lang.Boolean value)` Set dont parse links
`protected java.util.List<java.lang.String>`	`essentialKeys()` Get list of required parameter names
`MessagesSendQueryWithUserIds`	`forward(Forward value)` JSON describing the forwarded message or reply
`MessagesSendQueryWithUserIds`	`forwardMessages(java.lang.Integer... value)` forwardMessages ID of forwarded messages, separated with a comma.
`MessagesSendQueryWithUserIds`	`forwardMessages(java.util.List<java.lang.Integer> value)` ID of forwarded messages, separated with a comma.
`protected MessagesSendQueryWithUserIds`	`getThis()` Get reference to this object
`MessagesSendQueryWithUserIds`	`groupId(java.lang.Long value)` Group ID (for group messages with group access token)
`MessagesSendQueryWithUserIds`	`intent(SendIntent value)` Set intent
`MessagesSendQueryWithUserIds`	`keyboard(Keyboard value)` Set keyboard
`MessagesSendQueryWithUserIds`	`lat(java.lang.Number value)` Geographical latitude of a check-in, in degrees (from -90 to 90).
`MessagesSendQueryWithUserIds`	`lng(java.lang.Number value)` Geographical longitude of a check-in, in degrees (from -180 to 180).
`MessagesSendQueryWithUserIds`	`message(java.lang.String value)` (Required if 'attachments' is not set.)
`MessagesSendQueryWithUserIds`	`payload(java.lang.String value)` Set payload
`MessagesSendQueryWithUserIds`	`peerId(java.lang.Long value)` Destination ID.
`MessagesSendQueryWithUserIds`	`peerIds(java.util.List<java.lang.Long> value)` IDs of message recipients.
`MessagesSendQueryWithUserIds`	`peerIds(java.lang.Long... value)` peerIds IDs of message recipients.
`MessagesSendQueryWithUserIds`	`randomId(java.lang.Integer value)` Unique identifier to avoid resending the message.
`MessagesSendQueryWithUserIds`	`replyTo(java.lang.Integer value)` Set reply to
`MessagesSendQueryWithUserIds`	`stickerId(java.lang.Integer value)` Sticker id.
`MessagesSendQueryWithUserIds`	`subscribeId(java.lang.Integer value)` Set subscribe id
`MessagesSendQueryWithUserIds`	`template(java.lang.String value)` Set template
`MessagesSendQueryWithUserIds`	`userId(java.lang.Long value)` User ID (by default - current user).

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder
accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

Methods inherited from class com.vk.api.sdk.client.ApiRequest
addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessagesSendQueryWithUserIds
```
public MessagesSendQueryWithUserIds(VkApiClient client,
                                    GroupActor actor)
```
    Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
    
    Parameters:
    
    client - VK API client
    
    actor - actor with access token
  - MessagesSendQueryWithUserIds
```
public MessagesSendQueryWithUserIds(VkApiClient client,
                                    UserActor actor)
```
    Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
    
    Parameters:
    
    client - VK API client
    
    actor - actor with access token
- Method Detail
  - userId
```
public MessagesSendQueryWithUserIds userId(java.lang.Long value)
```
    User ID (by default - current user).
    
    Parameters:
    
    value - value of "user id" parameter. Entity - owner
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - randomId
```
public MessagesSendQueryWithUserIds randomId(java.lang.Integer value)
```
    Unique identifier to avoid resending the message.
    
    Parameters:
    
    value - value of "random id" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - peerId
```
public MessagesSendQueryWithUserIds peerId(java.lang.Long value)
```
    Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
    
    Parameters:
    
    value - value of "peer id" parameter. Entity - peer
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - domain
```
public MessagesSendQueryWithUserIds domain(java.lang.String value)
```
    User's short address (for example, 'illarionov').
    
    Parameters:
    
    value - value of "domain" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - chatId
```
public MessagesSendQueryWithUserIds chatId(java.lang.Integer value)
```
    ID of conversation the message will relate to.
    
    Parameters:
    
    value - value of "chat id" parameter. Maximum is 100000000. Minimum is 0.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - message
```
public MessagesSendQueryWithUserIds message(java.lang.String value)
```
    (Required if 'attachments' is not set.) Text of the message.
    
    Parameters:
    
    value - value of "message" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - lat
```
public MessagesSendQueryWithUserIds lat(java.lang.Number value)
```
    Geographical latitude of a check-in, in degrees (from -90 to 90).
    
    Parameters:
    
    value - value of "lat" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - lng
```
public MessagesSendQueryWithUserIds lng(java.lang.Number value)
```
    Geographical longitude of a check-in, in degrees (from -180 to 180).
    
    Parameters:
    
    value - value of "long" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - attachment
```
public MessagesSendQueryWithUserIds attachment(java.lang.String value)
```
    (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "_", ' - Type of media attachment: 'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document, 'wall' - wall post, '' - ID of the media attachment owner. '' - media attachment ID. Example: "photo100172_166443618"
    
    Parameters:
    
    value - value of "attachment" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - replyTo
```
public MessagesSendQueryWithUserIds replyTo(java.lang.Integer value)
```
    Set reply to
    
    Parameters:
    
    value - value of "reply to" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - forward
```
public MessagesSendQueryWithUserIds forward(Forward value)
```
    JSON describing the forwarded message or reply
    
    Parameters:
    
    value - value of "forward" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - stickerId
```
public MessagesSendQueryWithUserIds stickerId(java.lang.Integer value)
```
    Sticker id.
    
    Parameters:
    
    value - value of "sticker id" parameter. Minimum is 0.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - groupId
```
public MessagesSendQueryWithUserIds groupId(java.lang.Long value)
```
    Group ID (for group messages with group access token)
    
    Parameters:
    
    value - value of "group id" parameter. Minimum is 0. Entity - owner
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - keyboard
```
public MessagesSendQueryWithUserIds keyboard(Keyboard value)
```
    Set keyboard
    
    Parameters:
    
    value - value of "keyboard" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - template
```
public MessagesSendQueryWithUserIds template(java.lang.String value)
```
    Set template
    
    Parameters:
    
    value - value of "template" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - payload
```
public MessagesSendQueryWithUserIds payload(java.lang.String value)
```
    Set payload
    
    Parameters:
    
    value - value of "payload" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - contentSource
```
public MessagesSendQueryWithUserIds contentSource(java.lang.String value)
```
    JSON describing the content source in the message
    
    Parameters:
    
    value - value of "content source" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - dontParseLinks
```
public MessagesSendQueryWithUserIds dontParseLinks(java.lang.Boolean value)
```
    Set dont parse links
    
    Parameters:
    
    value - value of "dont parse links" parameter. By default false.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - disableMentions
```
public MessagesSendQueryWithUserIds disableMentions(java.lang.Boolean value)
```
    Set disable mentions
    
    Parameters:
    
    value - value of "disable mentions" parameter. By default false.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - intent
```
public MessagesSendQueryWithUserIds intent(SendIntent value)
```
    Set intent
    
    Parameters:
    
    value - value of "intent" parameter. By default default.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - subscribeId
```
public MessagesSendQueryWithUserIds subscribeId(java.lang.Integer value)
```
    Set subscribe id
    
    Parameters:
    
    value - value of "subscribe id" parameter. Maximum is 100. Minimum is 0.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - peerIds
```
public MessagesSendQueryWithUserIds peerIds(java.lang.Long... value)
```
    peerIds IDs of message recipients. (See peer_id)
    
    Parameters:
    
    value - value of "peer ids" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - peerIds
```
public MessagesSendQueryWithUserIds peerIds(java.util.List<java.lang.Long> value)
```
    IDs of message recipients. (See peer_id)
    
    Parameters:
    
    value - value of "peer ids" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - forwardMessages
```
public MessagesSendQueryWithUserIds forwardMessages(java.lang.Integer... value)
```
    forwardMessages 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"
    
    Parameters:
    
    value - value of "forward messages" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - forwardMessages
```
public MessagesSendQueryWithUserIds forwardMessages(java.util.List<java.lang.Integer> value)
```
    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"
    
    Parameters:
    
    value - value of "forward messages" parameter.
    
    Returns:
    
    a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
  - getThis
```
protected MessagesSendQueryWithUserIds getThis()
```
    Description copied from class: AbstractQueryBuilder
    
    Get reference to this object
    
    Specified by:
    
    getThis in class AbstractQueryBuilder<MessagesSendQueryWithUserIds,java.util.List<SendUserIdsResponse>>
    
    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<MessagesSendQueryWithUserIds,java.util.List<SendUserIdsResponse>>
    
    Returns:
    
    list of names

Class MessagesSendQueryWithUserIds

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

MessagesSendQueryWithUserIds

MessagesSendQueryWithUserIds

Method Detail

userId

randomId

peerId

domain

chatId

message

lat

lng

attachment

replyTo

forward

stickerId

groupId

keyboard

template

payload

contentSource

dontParseLinks

disableMentions

intent

subscribeId

peerIds

peerIds

forwardMessages

forwardMessages

getThis

essentialKeys