Skip to content

Commit da79591

Browse files
committed
doc: Added type documentation for metadata operations
1 parent a2393a6 commit da79591

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

Runtime/Game/Requests/MetadataRequests.cs

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,11 @@ public class LootLockerMetadataSourceAndEntries
248248
public class LootLockerMetadataOperationErrorKeyTypePair
249249
{
250250
/// <summary>
251-
/// TODO: Document
251+
/// The metadata key that the operation error refers to
252252
/// </summary>
253253
public string key { get; set; }
254254
/// <summary>
255-
/// TODO: Document
255+
/// The type of value that the set operation was for
256256
/// </summary>
257257
public LootLockerMetadataTypes type { get; set; }
258258
}
@@ -262,15 +262,15 @@ public class LootLockerMetadataOperationErrorKeyTypePair
262262
public class LootLockerMetadataOperationError
263263
{
264264
/// <summary>
265-
/// TODO: Document
265+
/// The type of action that this metadata operation was
266266
/// </summary>
267267
public LootLockerMetadataActions action { get; set; }
268268
/// <summary>
269-
/// TODO: Document
269+
/// The error message describing why this metadata set operation failed
270270
/// </summary>
271271
public string error { get; set; }
272272
/// <summary>
273-
/// TODO: Document
273+
/// The key and type of value that the operation was for
274274
/// </summary>
275275
public LootLockerMetadataOperationErrorKeyTypePair entry { get; set; }
276276
}
@@ -280,7 +280,7 @@ public class LootLockerMetadataOperationError
280280
public class LootLockerMetadataOperation : LootLockerMetadataEntry
281281
{
282282
/// <summary>
283-
/// TODO: Document
283+
/// The type of action to perform for this metadata operation
284284
/// </summary>
285285
LootLockerMetadataActions action { get; set; }
286286
}
@@ -302,19 +302,19 @@ public class LootLockerGetMultisourceMetadataRequest
302302
public class LootLockerMetadataOperationRequest
303303
{
304304
/// <summary>
305-
/// TODO: Document
305+
/// Whether or not this operation is for metadata on the current player
306306
/// </summary>
307307
public bool self { get; set; }
308308
/// <summary>
309-
/// TODO: Document
309+
/// The type of source that the source id refers to
310310
/// </summary>
311311
public string source { get; set; }
312312
/// <summary>
313-
/// TODO: Document
313+
/// The id of the specific source that the set operation was taken on, note that if source is set to self then this should also be set to "self"
314314
/// </summary>
315315
public string source_id { get; set; }
316316
/// <summary>
317-
/// TODO: Document
317+
/// List of operations to perform for the given source
318318
/// </summary>
319319
public LootLockerMetadataOperation[] entries { get; set; }
320320

@@ -362,15 +362,15 @@ public class LootLockerGetMultisourceMetadataResponse : LootLockerResponse
362362
public class LootLockerMetadataOperationsResponse : LootLockerResponse
363363
{
364364
/// <summary>
365-
/// TODO: Document
365+
/// The type of source that the source id refers to
366366
/// </summary>
367367
public LootLockerMetadataSources source { get; set; }
368368
/// <summary>
369-
/// TODO: Document
369+
/// The id of the specific source that the set operation was taken on, note that if source is set to self then this will also be set to "self"
370370
/// </summary>
371371
public string source_id { get; set; }
372372
/// <summary>
373-
/// TODO: Document
373+
/// A list of errors (if any) that occurred when executing the provided metadata actions
374374
/// </summary>
375375
public LootLockerMetadataOperationError[] errors { get; set; }
376376
}
@@ -483,3 +483,4 @@ public static void PerformMetadataOperations(LootLockerMetadataSources Source, s
483483
}
484484
}
485485
}
486+

0 commit comments

Comments
 (0)