class

GoogleDrive::CommentsApi

Inherits Reference / Object

Constants

DRIVE_COMMENTS_CREATE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

DRIVE_COMMENTS_DELETE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

DRIVE_COMMENTS_GET_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

DRIVE_COMMENTS_LIST_MAX_FOR_PAGE_SIZE = Int32.new("100")

DRIVE_COMMENTS_LIST_MIN_FOR_PAGE_SIZE = Int32.new("1")

DRIVE_COMMENTS_LIST_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

DRIVE_COMMENTS_UPDATE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

Constructors

new(api_client : GoogleDrive::ApiClient = ApiClient.default)

Instance methods

api_client

api_client=(api_client : ApiClient)

build_api_request_for_create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_delete(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, start_modified_time : String | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_update(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : Crest::Request

@return Crest::Request

client_side_validation?(*args, **options)

client_side_validation?(*args, **options, &)

create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : GoogleDrive::Comment

Creates a comment on a file. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return [GoogleDrive::Comment]

create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil, &block : Crest::Response -> ) : Nil

Creates a comment on a file. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return nil

create_with_http_info(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : Tuple(GoogleDrive::Comment, Int32, Hash(String, Array(String) | String))

Creates a comment on a file. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return [Tuple(GoogleDrive::Comment, Integer, Hash)] GoogleDrive::Comment, response status code and response headers

debugging?(*args, **options)

debugging?(*args, **options, &)

delete(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil) : Nil

Deletes a comment. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @return [Nil]

delete(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, &block : Crest::Response -> ) : Nil

Deletes a comment. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @return nil

delete_with_http_info(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))

Deletes a comment. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers

get(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil) : GoogleDrive::Comment

Gets a comment by ID. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to return deleted comments. Deleted comments will not include their original content. @return [GoogleDrive::Comment]

get(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil, &block : Crest::Response -> ) : Nil

Gets a comment by ID. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to return deleted comments. Deleted comments will not include their original content. @return nil

get_with_http_info(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil) : Tuple(GoogleDrive::Comment, Int32, Hash(String, Array(String) | String))

Gets a comment by ID. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to return deleted comments. Deleted comments will not include their original content. @return [Tuple(GoogleDrive::Comment, Integer, Hash)] GoogleDrive::Comment, response status code and response headers

list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, start_modified_time : String | Nil = nil) : GoogleDrive::CommentList

Lists a file's comments. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to include deleted comments. Deleted comments will not include their original content. @optional @param page_size [Int32?] The maximum number of comments to return per page. @optional @param page_token [String?] The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. @optional @param start_modified_time [String?] The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). @return [GoogleDrive::CommentList]

list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, start_modified_time : String | Nil = nil, &block : Crest::Response -> ) : Nil

Lists a file's comments. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to include deleted comments. Deleted comments will not include their original content. @optional @param page_size [Int32?] The maximum number of comments to return per page. @optional @param page_token [String?] The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. @optional @param start_modified_time [String?] The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). @return nil

list_with_http_info(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_deleted : Bool | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, start_modified_time : String | Nil = nil) : Tuple(GoogleDrive::CommentList, Int32, Hash(String, Array(String) | String))

Lists a file's comments. @required @param file_id [String?] The ID of the file. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_deleted [Bool?] Whether to include deleted comments. Deleted comments will not include their original content. @optional @param page_size [Int32?] The maximum number of comments to return per page. @optional @param page_token [String?] The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. @optional @param start_modified_time [String?] The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). @return [Tuple(GoogleDrive::CommentList, Integer, Hash)] GoogleDrive::CommentList, response status code and response headers

update(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : GoogleDrive::Comment

Updates a comment with patch semantics. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return [GoogleDrive::Comment]

update(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil, &block : Crest::Response -> ) : Nil

Updates a comment with patch semantics. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return nil

update_with_http_info(*, file_id : String | Nil = nil, comment_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, comment : GoogleDrive::Comment | Nil = nil) : Tuple(GoogleDrive::Comment, Int32, Hash(String, Array(String) | String))

Updates a comment with patch semantics. @required @param file_id [String?] The ID of the file. @required @param comment_id [String?] The ID of the comment. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param comment [GoogleDrive::Comment?] @return [Tuple(GoogleDrive::Comment, Integer, Hash)] GoogleDrive::Comment, response status code and response headers