com.google.api.services.youtube

Class YouTube.Comments.SetModerationStatus

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<java.lang.Void>

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

YouTube.Comments

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

Nested Class Summary

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

com.google.api.client.util.GenericData.Flags

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getBanAuthor() The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author.
java.lang.String	getId() The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.
java.lang.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(java.lang.String parameterName, java.lang.Object value)
YouTube.Comments.SetModerationStatus	setAlt(java.lang.String alt) Data format for the response.
YouTube.Comments.SetModerationStatus	setBanAuthor(java.lang.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(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.Comments.SetModerationStatus	setId(java.lang.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(java.lang.String key) API key.
YouTube.Comments.SetModerationStatus	setModerationStatus(java.lang.String moderationStatus) Identifies the new moderation status of the specified comments.
YouTube.Comments.SetModerationStatus	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.Comments.SetModerationStatus	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Comments.SetModerationStatus	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Comments.SetModerationStatus	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

YouTube.Comments.SetModerationStatus

protected YouTube.Comments.SetModerationStatus(java.lang.String id,
                                    java.lang.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(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<java.lang.Void>

setFields

public YouTube.Comments.SetModerationStatus setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<java.lang.Void>

setKey

public YouTube.Comments.SetModerationStatus setKey(java.lang.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<java.lang.Void>

setOauthToken

public YouTube.Comments.SetModerationStatus setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<java.lang.Void>

setPrettyPrint

public YouTube.Comments.SetModerationStatus setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<java.lang.Void>

setQuotaUser

public YouTube.Comments.SetModerationStatus setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<java.lang.Void>

setUserIp

public YouTube.Comments.SetModerationStatus setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class YouTubeRequest<java.lang.Void>

getId

public java.lang.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(java.lang.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 java.lang.String getModerationStatus()

Identifies the new moderation status of the specified comments.

setModerationStatus

public YouTube.Comments.SetModerationStatus setModerationStatus(java.lang.String moderationStatus)

Identifies the new moderation status of the specified comments.

getBanAuthor

public java.lang.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(java.lang.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(java.lang.String parameterName,
                                       java.lang.Object value)

Overrides:

set in class YouTubeRequest<java.lang.Void>