/docs/core/com.vmadalin.core.database.characterfavorite/-character-favorite-repository/index.html

https://github.com/VMadalin/kotlin-sample-app · HTML · 96 lines · 96 code · 0 blank · 0 comment · 0 complexity · 8a98991eb6b5944c81fea1cdcf585e23 MD5 · raw file 

    

  1. <HTML>
    2. 

  2. <HEAD>
    3. 

  3. <meta charset="UTF-8">
    4. 

  4. <title>CharacterFavoriteRepository - core</title>
    5. 

  5. <link rel="stylesheet" href="../../../style.css">
    6. 

  6. </HEAD>
    7. 

  7. <BODY>
    8. 

  8. <a href="../../index.html">core</a>&nbsp;/&nbsp;<a href="../index.html">com.vmadalin.core.database.characterfavorite</a>&nbsp;/&nbsp;<a href="./index.html">CharacterFavoriteRepository</a><br/>
    9. 

  9. <br/>
    10. 

  10. <h1>CharacterFavoriteRepository</h1>
    11. 

  11. <code><span class="keyword">class </span><span class="identifier">CharacterFavoriteRepository</span></code>
    12. 

  12. <p>Repository module for handling character favorite data operations <a href="../-character-favorite-dao/index.html">CharacterFavoriteDao</a>.</p>
    13. 

  13. <h3>Constructors</h3>
    14. 

  14. <table>
    15. 

  15. <tbody>
    16. 

  16. <tr>
    17. 

  17. <td>
    18. 

  18. <h4><a href="-init-.html">&lt;init&gt;</a></h4>
    19. 

  19. </td>
    20. 

  20. <td>
    21. 

  21. <p>Repository module for handling character favorite data operations <a href="../-character-favorite-dao/index.html">CharacterFavoriteDao</a>.</p>
    22. 

  22. <code><span class="identifier">CharacterFavoriteRepository</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$<init>(com.vmadalin.core.database.characterfavorite.CharacterFavoriteDao)/characterFavoriteDao">characterFavoriteDao</span><span class="symbol">:</span>&nbsp;<a href="../-character-favorite-dao/index.html"><span class="identifier">CharacterFavoriteDao</span></a><span class="symbol">)</span></code></td>
    23. 

  23. </tr>
    24. 

  24. </tbody>
    25. 

  25. </table>
    26. 

  26. <h3>Functions</h3>
    27. 

  27. <table>
    28. 

  28. <tbody>
    29. 

  29. <tr>
    30. 

  30. <td>
    31. 

  31. <h4><a href="delete-all-characters-favorite.html">deleteAllCharactersFavorite</a></h4>
    32. 

  32. </td>
    33. 

  33. <td>
    34. 

  34. <p>Delete all database favorite characters.</p>
    35. 

  35. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">deleteAllCharactersFavorite</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
    36. 

  36. </tr>
    37. 

  37. <tr>
    38. 

  38. <td>
    39. 

  39. <h4><a href="delete-character-favorite.html">deleteCharacterFavorite</a></h4>
    40. 

  40. </td>
    41. 

  41. <td>
    42. 

  42. <p>Delete database favorite character.</p>
    43. 

  43. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">deleteCharacterFavorite</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$deleteCharacterFavorite(com.vmadalin.core.database.characterfavorite.CharacterFavorite)/character">character</span><span class="symbol">:</span>&nbsp;<a href="../-character-favorite/index.html"><span class="identifier">CharacterFavorite</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
    44. 

  44. </tr>
    45. 

  45. <tr>
    46. 

  46. <td>
    47. 

  47. <h4><a href="delete-character-favorite-by-id.html">deleteCharacterFavoriteById</a></h4>
    48. 

  48. </td>
    49. 

  49. <td>
    50. 

  50. <p>Delete database favorite character by identifier.</p>
    51. 

  51. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">deleteCharacterFavoriteById</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$deleteCharacterFavoriteById(kotlin.Long)/characterFavoriteId">characterFavoriteId</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
    52. 

  52. </tr>
    53. 

  53. <tr>
    54. 

  54. <td>
    55. 

  55. <h4><a href="get-all-characters-favorite.html">getAllCharactersFavorite</a></h4>
    56. 

  56. </td>
    57. 

  57. <td>
    58. 

  58. <p>Obtain all database added favorite characters ordering by name field.</p>
    59. 

  59. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getAllCharactersFavorite</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../-character-favorite/index.html"><span class="identifier">CharacterFavorite</span></a><span class="symbol">&gt;</span></code></td>
    60. 

  60. </tr>
    61. 

  61. <tr>
    62. 

  62. <td>
    63. 

  63. <h4><a href="get-all-characters-favorite-live-data.html">getAllCharactersFavoriteLiveData</a></h4>
    64. 

  64. </td>
    65. 

  65. <td>
    66. 

  66. <p>Obtain all database added favorite characters ordering by name field.</p>
    67. 

  67. <code><span class="keyword">fun </span><span class="identifier">getAllCharactersFavoriteLiveData</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">LiveData</span><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../-character-favorite/index.html"><span class="identifier">CharacterFavorite</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code></td>
    68. 

  68. </tr>
    69. 

  69. <tr>
    70. 

  70. <td>
    71. 

  71. <h4><a href="get-character-favorite.html">getCharacterFavorite</a></h4>
    72. 

  72. </td>
    73. 

  73. <td>
    74. 

  74. <p>Obtain database favorite character by identifier.</p>
    75. 

  75. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getCharacterFavorite</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$getCharacterFavorite(kotlin.Long)/characterFavoriteId">characterFavoriteId</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-character-favorite/index.html"><span class="identifier">CharacterFavorite</span></a><span class="symbol">?</span></code></td>
    76. 

  76. </tr>
    77. 

  77. <tr>
    78. 

  78. <td>
    79. 

  79. <h4><a href="insert-character-favorite.html">insertCharacterFavorite</a></h4>
    80. 

  80. </td>
    81. 

  81. <td>
    82. 

  82. <p>Add to database a favorite character.</p>
    83. 

  83. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">insertCharacterFavorite</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$insertCharacterFavorite(kotlin.Long, kotlin.String, kotlin.String)/id">id</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a><span class="symbol">, </span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$insertCharacterFavorite(kotlin.Long, kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$insertCharacterFavorite(kotlin.Long, kotlin.String, kotlin.String)/imageUrl">imageUrl</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
    84. 

  84. </tr>
    85. 

  85. <tr>
    86. 

  86. <td>
    87. 

  87. <h4><a href="insert-characters-favorites.html">insertCharactersFavorites</a></h4>
    88. 

  88. </td>
    89. 

  89. <td>
    90. 

  90. <p>Add to database a list of favorite characters.</p>
    91. 

  91. <code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">insertCharactersFavorites</span><span class="symbol">(</span><span class="identifier" id="com.vmadalin.core.database.characterfavorite.CharacterFavoriteRepository$insertCharactersFavorites(kotlin.collections.List((com.vmadalin.core.database.characterfavorite.CharacterFavorite)))/characters">characters</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../-character-favorite/index.html"><span class="identifier">CharacterFavorite</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
    92. 

  92. </tr>
    93. 

  93. </tbody>
    94. 

  94. </table>
    95. 

  95. </BODY>
    96. 

  96. </HTML>
    97.