getHistory method

Future<TautulliHistory> getHistory({
  1. bool? grouping,
  2. String? user,
  3. int? userId,
  4. int? ratingKey,
  5. int? parentRatingKey,
  6. int? grandparentRatingKey,
  7. String? startDate,
  8. int? sectionId,
  9. TautulliMediaType? mediaType,
  10. TautulliTranscodeDecision? transcodeDecision,
  11. String? guid,
  12. TautulliHistoryOrderColumn? orderColumn,
  13. TautulliOrderDirection? orderDirection,
  14. int? start,
  15. int? length,
  16. String? search,
})

Handler for get_history.

Get the Tautulli history.

Optional Parameters:

  • grouping: Group data
  • user: User's name
  • userId: User's ID
  • ratingKey: Identifier/rating key for the content itself
  • parentRatingKey: Identifier/rating key for the content's parent
  • grandparentRatingKey: Identifier/rating key for the content's grandparent
  • startDate: String DateTime format structured as "YYYY-MM-DD"
  • sectionId: Section ID to fetch history for
  • mediaType: Type of media to fetch history for
  • transcodeDecision: To fetch history only for records with a specific transcoding decision
  • guid: Plex GUID for an item
  • orderColumn: The column order key for sorting the history records
  • orderDirection: The direction to sort the history records
  • start: Which row to start at (default: 0)
  • length: Number of records to return (default: 25)
  • search: A string to search for

Implementation

Future<TautulliHistory> getHistory({
    bool? grouping,
    String? user,
    int? userId,
    int? ratingKey,
    int? parentRatingKey,
    int? grandparentRatingKey,
    String? startDate,
    int? sectionId,
    TautulliMediaType? mediaType,
    TautulliTranscodeDecision? transcodeDecision,
    String? guid,
    TautulliHistoryOrderColumn? orderColumn,
    TautulliOrderDirection? orderDirection,
    int? start,
    int? length,
    String? search,
}) async => _commandGetHistory(
    _client,
    grouping: grouping,
    user: user,
    userId: userId,
    ratingKey: ratingKey,
    parentRatingKey: parentRatingKey,
    grandparentRatingKey: grandparentRatingKey,
    startDate: startDate,
    sectionId: sectionId,
    mediaType: mediaType,
    transcodeDecision: transcodeDecision,
    guid: guid,
    orderColumn: orderColumn,
    orderDirection: orderDirection,
    start: start,
    length: length,
    search: search,
);