Blame - docs/dyn/drive_v2.replies.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

156

<code class="details" id="insert">insert(fileId, commentId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

157

<pre>Creates a new reply to the given comment.

158

159

Args:

160

fileId: string, The ID of the file. (required)

161

commentId: string, The ID of the comment. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

162

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

163

The object takes the form of:

164

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

165

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

166

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

167

"displayName": "A String", # A plain text displayable name for this user.

168

"emailAddress": "A String", # The email address of the user.

169

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

170

"kind": "drive#user", # This is always drive#user.

171

"permissionId": "A String", # The user's ID as visible in the permissions collection.

172

"picture": { # The user's profile picture.

173

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

174

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

175

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

177

"createdDate": "A String", # The date when this reply was first created.

178

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

179

"htmlContent": "A String", # HTML formatted content for this reply.

180

"kind": "drive#commentReply", # This is always drive#commentReply.

181

"modifiedDate": "A String", # The date when this reply was last modified.

182

"replyId": "A String", # The ID of the reply.

183

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

184

# - "resolve" - To resolve a comment.

185

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

191

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

192

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

193

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

194

"displayName": "A String", # A plain text displayable name for this user.

195

"emailAddress": "A String", # The email address of the user.

196

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

197

"kind": "drive#user", # This is always drive#user.

198

"permissionId": "A String", # The user's ID as visible in the permissions collection.

199

"picture": { # The user's profile picture.

200

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

201

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

202

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

203

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

204

"createdDate": "A String", # The date when this reply was first created.

205

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

206

"htmlContent": "A String", # HTML formatted content for this reply.

207

"kind": "drive#commentReply", # This is always drive#commentReply.

208

"modifiedDate": "A String", # The date when this reply was last modified.

209

"replyId": "A String", # The ID of the reply.

210

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

211

# - "resolve" - To resolve a comment.

212

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

217

<code class="details" id="list">list(fileId, commentId, includeDeleted=None, maxResults=None, pageToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

218

<pre>Lists all of the replies to a comment.

219

220

Args:

221

fileId: string, The ID of the file. (required)

222

commentId: string, The ID of the comment. (required)

223

includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

224

maxResults: integer, The maximum number of replies to include in the response, used for paging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

226

227

Returns:

228

An object of the form:

229

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

230

{ # A list of replies to a comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

231

"items": [ # The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

232

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

233

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

234

"displayName": "A String", # A plain text displayable name for this user.

235

"emailAddress": "A String", # The email address of the user.

236

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

237

"kind": "drive#user", # This is always drive#user.

238

"permissionId": "A String", # The user's ID as visible in the permissions collection.

239

"picture": { # The user's profile picture.

240

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

241

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

242

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

243

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

244

"createdDate": "A String", # The date when this reply was first created.

245

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

246

"htmlContent": "A String", # HTML formatted content for this reply.

247

"kind": "drive#commentReply", # This is always drive#commentReply.

248

"modifiedDate": "A String", # The date when this reply was last modified.

249

"replyId": "A String", # The ID of the reply.

250

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

251

# - "resolve" - To resolve a comment.

252

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

253

},

254

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

255

"kind": "drive#commentReplyList", # This is always drive#commentReplyList.

256

"nextLink": "A String", # A link to the next page of replies.

257

"nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.

258

"selfLink": "A String", # A link back to this list.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

264

<pre>Retrieves the next page of results.

265

266

Args:

267

previous_request: The request for the previous page. (required)

268

previous_response: The response from the request for the previous page. (required)

269

270

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

271

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

272

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

277

<code class="details" id="patch">patch(fileId, commentId, replyId, body=None)</code>

278

<pre>Updates an existing reply.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

279

280

Args:

281

fileId: string, The ID of the file. (required)

282

commentId: string, The ID of the comment. (required)

283

replyId: string, The ID of the reply. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

284

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

285

The object takes the form of:

286

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

287

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

288

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

289

"displayName": "A String", # A plain text displayable name for this user.

290

"emailAddress": "A String", # The email address of the user.

291

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

292

"kind": "drive#user", # This is always drive#user.

293

"permissionId": "A String", # The user's ID as visible in the permissions collection.

294

"picture": { # The user's profile picture.

295

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

296

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

297

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

298

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

299

"createdDate": "A String", # The date when this reply was first created.

300

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

301

"htmlContent": "A String", # HTML formatted content for this reply.

302

"kind": "drive#commentReply", # This is always drive#commentReply.

303

"modifiedDate": "A String", # The date when this reply was last modified.

304

"replyId": "A String", # The ID of the reply.

305

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

306

# - "resolve" - To resolve a comment.

307

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

313

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

314

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

316

"displayName": "A String", # A plain text displayable name for this user.

317

"emailAddress": "A String", # The email address of the user.

318

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

319

"kind": "drive#user", # This is always drive#user.

320

"permissionId": "A String", # The user's ID as visible in the permissions collection.

321

"picture": { # The user's profile picture.

322

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

323

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

324

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

326

"createdDate": "A String", # The date when this reply was first created.

327

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

328

"htmlContent": "A String", # HTML formatted content for this reply.

329

"kind": "drive#commentReply", # This is always drive#commentReply.

330

"modifiedDate": "A String", # The date when this reply was last modified.

331

"replyId": "A String", # The ID of the reply.

332

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

333

# - "resolve" - To resolve a comment.

334

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

339

<code class="details" id="update">update(fileId, commentId, replyId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

340

<pre>Updates an existing reply.

341

342

Args:

343

fileId: string, The ID of the file. (required)

344

commentId: string, The ID of the comment. (required)

345

replyId: string, The ID of the reply. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

346

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

347

The object takes the form of:

348

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

349

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

350

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

351

"displayName": "A String", # A plain text displayable name for this user.

352

"emailAddress": "A String", # The email address of the user.

353

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

354

"kind": "drive#user", # This is always drive#user.

355

"permissionId": "A String", # The user's ID as visible in the permissions collection.

356

"picture": { # The user's profile picture.

357

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

358

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

359

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

360

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

361

"createdDate": "A String", # The date when this reply was first created.

362

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

363

"htmlContent": "A String", # HTML formatted content for this reply.

364

"kind": "drive#commentReply", # This is always drive#commentReply.

365

"modifiedDate": "A String", # The date when this reply was last modified.

366

"replyId": "A String", # The ID of the reply.

367

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

368

# - "resolve" - To resolve a comment.

369

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

375

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

376

{ # A comment on a file in Google Drive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

377

"author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.

378

"displayName": "A String", # A plain text displayable name for this user.

379

"emailAddress": "A String", # The email address of the user.

380

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

381

"kind": "drive#user", # This is always drive#user.

382

"permissionId": "A String", # The user's ID as visible in the permissions collection.

383

"picture": { # The user's profile picture.

384

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

385

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

386

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

387

"content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).

388

"createdDate": "A String", # The date when this reply was first created.

389

"deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.

390

"htmlContent": "A String", # HTML formatted content for this reply.

391

"kind": "drive#commentReply", # This is always drive#commentReply.

392

"modifiedDate": "A String", # The date when this reply was last modified.

393

"replyId": "A String", # The ID of the reply.

394

"verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:

395

# - "resolve" - To resolve a comment.

396

# - "reopen" - To reopen (un-resolve) a comment.

John Asmuth