com.google.api.services.youtube

Class YouTube.Comments.SetModerationStatus

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<Void>

com.google.api.services.youtube.YouTube.Comments.SetModerationStatus

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Comments

public class YouTube.Comments.SetModerationStatus
extends YouTubeRequest<Void>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SetModerationStatus(List<String> id, String moderationStatus) Sets the moderation status of one or more comments.

Method Summary

Modifier and Type	Method and Description
Boolean	getBanAuthor() If set to true the author of the comment gets added to the ban list.
List<String>	getId() Modifies the moderation status of the comments with the given IDs
String	getModerationStatus() Specifies the requested moderation status.
boolean	isBanAuthor() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
YouTube.Comments.SetModerationStatus	set(String parameterName, Object value)
YouTube.Comments.SetModerationStatus	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Comments.SetModerationStatus	setAccessToken(String accessToken) OAuth access token.
YouTube.Comments.SetModerationStatus	setAlt(String alt) Data format for response.
YouTube.Comments.SetModerationStatus	setBanAuthor(Boolean banAuthor) If set to true the author of the comment gets added to the ban list.
YouTube.Comments.SetModerationStatus	setCallback(String callback) JSONP
YouTube.Comments.SetModerationStatus	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Comments.SetModerationStatus	setId(List<String> id) Modifies the moderation status of the comments with the given IDs
YouTube.Comments.SetModerationStatus	setKey(String key) API key.
YouTube.Comments.SetModerationStatus	setModerationStatus(String moderationStatus) Specifies the requested moderation status.
YouTube.Comments.SetModerationStatus	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Comments.SetModerationStatus	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Comments.SetModerationStatus	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Comments.SetModerationStatus	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Comments.SetModerationStatus	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SetModerationStatus

protected SetModerationStatus(List<String> id,
                              String moderationStatus)

Sets the moderation status of one or more comments. Create a request for the method "comments.setModerationStatus". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

SetModerationStatus#initialize(com.google.api.client.googleapis.services. AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

id - Modifies the moderation status of the comments with the given IDs

moderationStatus - Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.

Since:

1.13

Method Detail

set$Xgafv

public YouTube.Comments.SetModerationStatus set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<Void>

setAccessToken

public YouTube.Comments.SetModerationStatus setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<Void>

setAlt

public YouTube.Comments.SetModerationStatus setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<Void>

setCallback

public YouTube.Comments.SetModerationStatus setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<Void>

setFields

public YouTube.Comments.SetModerationStatus setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Void>

setKey

public YouTube.Comments.SetModerationStatus setKey(String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<Void>

setOauthToken

public YouTube.Comments.SetModerationStatus setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Void>

setPrettyPrint

public YouTube.Comments.SetModerationStatus setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Void>

setQuotaUser

public YouTube.Comments.SetModerationStatus setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<Void>

setUploadType

public YouTube.Comments.SetModerationStatus setUploadType(String uploadType)

Description copied from class: YouTubeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class YouTubeRequest<Void>

setUploadProtocol

public YouTube.Comments.SetModerationStatus setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class YouTubeRequest<Void>

getId

public List<String> getId()

Modifies the moderation status of the comments with the given IDs

setId

public YouTube.Comments.SetModerationStatus setId(List<String> id)

Modifies the moderation status of the comments with the given IDs

getModerationStatus

public String getModerationStatus()

Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.

setModerationStatus

public YouTube.Comments.SetModerationStatus setModerationStatus(String moderationStatus)

Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.

getBanAuthor

public Boolean getBanAuthor()

If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED. [default: false]

setBanAuthor

public YouTube.Comments.SetModerationStatus setBanAuthor(Boolean banAuthor)

If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.

isBanAuthor

public boolean isBanAuthor()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.

set

public YouTube.Comments.SetModerationStatus set(String parameterName,
                                                Object value)

Overrides:

set in class YouTubeRequest<Void>