@@ -313,17 +313,15 @@ partial interface IDynamoDBContext
313
313
Task DeleteAsync < [ DynamicallyAccessedMembers ( InternalConstants . DataModelModeledType ) ] T > ( T value , DeleteConfig deleteConfig , CancellationToken cancellationToken = default ) ;
314
314
315
315
/// <summary>
316
- /// Deletes an item in DynamoDB corresponding to given hash key.
317
- /// </summary>
318
- /// <remarks>
319
- /// If SkipVersionCheck if false, it will check the version of object before deleting.
320
- /// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
321
- /// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
322
- /// </remarks>
323
- /// <typeparam name="T">Type of object.</typeparam>
324
- /// <param name="hashKey">Hash key element of the object to delete.</param>
325
- /// <param name="cancellationToken">Token which can be used to cancel the task.</param>
326
- /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
316
+ /// Deletes an item in DynamoDB corresponding to the given hash key.
317
+ /// </summary>
318
+ /// <typeparam name="T">
319
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
320
+ /// either from attributes or via configuration.
321
+ /// </typeparam>
322
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
323
+ /// <param name="cancellationToken">Token that can be used to cancel the operation.</param>
324
+ /// <returns>A <see cref="Task"/> that can be awaited for operation completion.</returns>
327
325
Task DeleteAsync < [ DynamicallyAccessedMembers ( InternalConstants . DataModelModeledType ) ] T > ( object hashKey , CancellationToken cancellationToken = default ) ;
328
326
329
327
/// <summary>
@@ -334,8 +332,11 @@ partial interface IDynamoDBContext
334
332
/// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
335
333
/// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
336
334
/// </remarks>
337
- /// <typeparam name="T">Type of object.</typeparam>
338
- /// <param name="hashKey">Hash key element of the object to delete.</param>
335
+ /// <typeparam name="T">
336
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
337
+ /// either from attributes or via configuration.
338
+ /// </typeparam>
339
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
339
340
/// <param name="operationConfig">Config object which can be used to override that table used.</param>
340
341
/// <param name="cancellationToken">Token which can be used to cancel the task.</param>
341
342
/// <returns>A Task that can be used to poll or wait for results, or both.</returns>
@@ -350,8 +351,11 @@ partial interface IDynamoDBContext
350
351
/// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
351
352
/// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
352
353
/// </remarks>
353
- /// <typeparam name="T">Type of object.</typeparam>
354
- /// <param name="hashKey">Hash key element of the object to delete.</param>
354
+ /// <typeparam name="T">
355
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
356
+ /// either from attributes or via configuration.
357
+ /// </typeparam>
358
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
355
359
/// <param name="deleteConfig">Config object that can be used to override properties on the table's context for this request.</param>
356
360
/// <param name="cancellationToken">Token which can be used to cancel the task.</param>
357
361
/// <returns>A Task that can be used to poll or wait for results, or both.</returns>
@@ -365,8 +369,11 @@ partial interface IDynamoDBContext
365
369
/// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
366
370
/// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
367
371
/// </remarks>
368
- /// <typeparam name="T">Type of object.</typeparam>
369
- /// <param name="hashKey">Hash key element of the object to delete.</param>
372
+ /// <typeparam name="T">
373
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
374
+ /// either from attributes or via configuration.
375
+ /// </typeparam>
376
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
370
377
/// <param name="rangeKey">Range key element of the object to delete.</param>
371
378
/// <param name="cancellationToken">Token which can be used to cancel the task.</param>
372
379
/// <returns>A Task that can be used to poll or wait for results, or both.</returns>
@@ -380,8 +387,11 @@ partial interface IDynamoDBContext
380
387
/// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
381
388
/// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
382
389
/// </remarks>
383
- /// <typeparam name="T">Type of object.</typeparam>
384
- /// <param name="hashKey">Hash key element of the object to delete.</param>
390
+ /// <typeparam name="T">
391
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
392
+ /// either from attributes or via configuration.
393
+ /// </typeparam>
394
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
385
395
/// <param name="rangeKey">Range key element of the object to delete.</param>
386
396
/// <param name="operationConfig">Config object which can be used to override that table used.</param>
387
397
/// <param name="cancellationToken">Token which can be used to cancel the task.</param>
@@ -397,8 +407,11 @@ partial interface IDynamoDBContext
397
407
/// The type must be marked up with <see cref="DynamoDBTableAttribute" /> and at least
398
408
/// one public field/property with <see cref="DynamoDBHashKeyAttribute" />.
399
409
/// </remarks>
400
- /// <typeparam name="T">Type of object.</typeparam>
401
- /// <param name="hashKey">Hash key element of the object to delete.</param>
410
+ /// <typeparam name="T">
411
+ /// The type representing the item stored in DynamoDB. It must be resolvable via table metadata,
412
+ /// either from attributes or via configuration.
413
+ /// </typeparam>
414
+ /// <param name="hashKey">The value of the hash (partition) key identifying the item to delete.</param>
402
415
/// <param name="rangeKey">Range key element of the object to delete.</param>
403
416
/// <param name="deleteConfig">Config object that can be used to override properties on the table's context for this request.</param>
404
417
/// <param name="cancellationToken">Token which can be used to cancel the task.</param>
0 commit comments