com.vk.api.sdk.queries.notifications

Class NotificationsSendMessageQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<NotificationsSendMessageQuery,java.util.List<SendMessageResponse>>

com.vk.api.sdk.queries.notifications.NotificationsSendMessageQuery

public class NotificationsSendMessageQuery
extends AbstractQueryBuilder<NotificationsSendMessageQuery,java.util.List<SendMessageResponse>>

Query for Notifications.sendMessage method

Constructor Summary

Constructors

Constructor and Description
NotificationsSendMessageQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
NotificationsSendMessageQuery(VkApiClient client, ServiceActor actor, java.lang.String message, java.util.List<java.lang.Long> userIds) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
NotificationsSendMessageQuery(VkApiClient client, ServiceActor actor, java.lang.String message, java.lang.Long... userIds) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
NotificationsSendMessageQuery	fragment(java.lang.String value) Set fragment
protected NotificationsSendMessageQuery	getThis() Get reference to this object
NotificationsSendMessageQuery	groupId(java.lang.Long value) Set group id
NotificationsSendMessageQuery	message(java.lang.String value) Set message
NotificationsSendMessageQuery	randomId(java.lang.Integer value) Set random id
NotificationsSendMessageQuery	sendingMode(SendMessageSendingMode value) Type of sending (delivering) notifications: 'immediately' - push and bell notifications will be delivered as soon as possible, 'delayed' - push and bell notifications will be delivered in the most comfortable time for the user, 'delayed_push' - only push notifications will be delivered in the most comfortable time, while the bell notifications will be delivered as soon as possible
NotificationsSendMessageQuery	userIds(java.util.List<java.lang.Long> value) Set user ids
NotificationsSendMessageQuery	userIds(java.lang.Long... value) userIds Set user ids

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

NotificationsSendMessageQuery

public NotificationsSendMessageQuery(VkApiClient client,
                                     ServiceActor actor,
                                     java.lang.String message,
                                     java.lang.Long... userIds)

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

Parameters:

client - VK API client

actor - actor with access token

message - value of "message" parameter.

userIds - value of "user ids" parameter.

NotificationsSendMessageQuery

public NotificationsSendMessageQuery(VkApiClient client,
                                     ServiceActor actor,
                                     java.lang.String message,
                                     java.util.List<java.lang.Long> userIds)

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

Parameters:

client - VK API client

actor - actor with access token

message - value of "message" parameter.

userIds - value of "user ids" parameter.

NotificationsSendMessageQuery

public NotificationsSendMessageQuery(VkApiClient client,
                                     ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

message

public NotificationsSendMessageQuery message(java.lang.String value)

Set message

Parameters:

value - value of "message" parameter.

Returns:

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

fragment

public NotificationsSendMessageQuery fragment(java.lang.String value)

Set fragment

Parameters:

value - value of "fragment" parameter.

Returns:

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

groupId

public NotificationsSendMessageQuery groupId(java.lang.Long value)

Set group id

Parameters:

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

Returns:

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

randomId

public NotificationsSendMessageQuery randomId(java.lang.Integer value)

Set random id

Parameters:

value - value of "random id" parameter.

Returns:

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

sendingMode

public NotificationsSendMessageQuery sendingMode(SendMessageSendingMode value)

Type of sending (delivering) notifications: 'immediately' - push and bell notifications will be delivered as soon as possible, 'delayed' - push and bell notifications will be delivered in the most comfortable time for the user, 'delayed_push' - only push notifications will be delivered in the most comfortable time, while the bell notifications will be delivered as soon as possible

Parameters:

value - value of "sending mode" parameter. By default immediately.

Returns:

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

userIds

public NotificationsSendMessageQuery userIds(java.lang.Long... value)

userIds Set user ids

Parameters:

value - value of "user ids" parameter.

Returns:

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

userIds

public NotificationsSendMessageQuery userIds(java.util.List<java.lang.Long> value)

Set user ids

Parameters:

value - value of "user ids" parameter.

Returns:

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

getThis

protected NotificationsSendMessageQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<NotificationsSendMessageQuery,java.util.List<SendMessageResponse>>

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<NotificationsSendMessageQuery,java.util.List<SendMessageResponse>>

Returns:

list of names