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(String id, String moderationStatus) Sets the moderation status of one or more comments.

Method Summary

Modifier and Type	Method and Description
Boolean	getBanAuthor() The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author.
String	getId() The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.
String	getModerationStatus() Identifies the new moderation status of the specified comments.
boolean	isBanAuthor() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
YouTube.Comments.SetModerationStatus	set(String parameterName, Object value)
YouTube.Comments.SetModerationStatus	setAlt(String alt) Data format for the response.
YouTube.Comments.SetModerationStatus	setBanAuthor(Boolean banAuthor) The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author.
YouTube.Comments.SetModerationStatus	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Comments.SetModerationStatus	setId(String id) The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.
YouTube.Comments.SetModerationStatus	setKey(String key) API key.
YouTube.Comments.SetModerationStatus	setModerationStatus(String moderationStatus) Identifies the new moderation status of the specified comments.
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) An opaque string that represents a user for quota purposes.
YouTube.Comments.SetModerationStatus	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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(String id,
                              String moderationStatus)

Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the 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 - The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.

moderationStatus - Identifies the new moderation status of the specified comments.

Since:

1.13

Method Detail

setAlt

public YouTube.Comments.SetModerationStatus setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt 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

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<Void>

setUserIp

public YouTube.Comments.SetModerationStatus setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<Void>

getId

public String getId()

The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.

setId

public YouTube.Comments.SetModerationStatus setId(String id)

The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.

getModerationStatus

public String getModerationStatus()

Identifies the new moderation status of the specified comments.

setModerationStatus

public YouTube.Comments.SetModerationStatus setModerationStatus(String moderationStatus)

Identifies the new moderation status of the specified comments.

getBanAuthor

public Boolean getBanAuthor()

The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author. Note: This parameter is only valid if the moderationStatus parameter is also set to rejected. [default: false]

setBanAuthor

public YouTube.Comments.SetModerationStatus setBanAuthor(Boolean banAuthor)

The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author. Note: This parameter is only valid if the moderationStatus parameter is also set to 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.

The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author. Note: This parameter is only valid if the moderationStatus parameter is also set to rejected.

set

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

Overrides:

set in class YouTubeRequest<Void>