domstorage.go 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. // Package domstorage provides the Chrome DevTools Protocol
  2. // commands, types, and events for the DOMStorage domain.
  3. //
  4. // Query and modify DOM storage.
  5. //
  6. // Generated by the cdproto-gen command.
  7. package domstorage
  8. // Code generated by cdproto-gen. DO NOT EDIT.
  9. import (
  10. "context"
  11. "github.com/chromedp/cdproto/cdp"
  12. )
  13. // ClearParams [no description].
  14. type ClearParams struct {
  15. StorageID *StorageID `json:"storageId"`
  16. }
  17. // Clear [no description].
  18. //
  19. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-clear
  20. //
  21. // parameters:
  22. //
  23. // storageID
  24. func Clear(storageID *StorageID) *ClearParams {
  25. return &ClearParams{
  26. StorageID: storageID,
  27. }
  28. }
  29. // Do executes DOMStorage.clear against the provided context.
  30. func (p *ClearParams) Do(ctx context.Context) (err error) {
  31. return cdp.Execute(ctx, CommandClear, p, nil)
  32. }
  33. // DisableParams disables storage tracking, prevents storage events from
  34. // being sent to the client.
  35. type DisableParams struct{}
  36. // Disable disables storage tracking, prevents storage events from being sent
  37. // to the client.
  38. //
  39. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-disable
  40. func Disable() *DisableParams {
  41. return &DisableParams{}
  42. }
  43. // Do executes DOMStorage.disable against the provided context.
  44. func (p *DisableParams) Do(ctx context.Context) (err error) {
  45. return cdp.Execute(ctx, CommandDisable, nil, nil)
  46. }
  47. // EnableParams enables storage tracking, storage events will now be
  48. // delivered to the client.
  49. type EnableParams struct{}
  50. // Enable enables storage tracking, storage events will now be delivered to
  51. // the client.
  52. //
  53. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-enable
  54. func Enable() *EnableParams {
  55. return &EnableParams{}
  56. }
  57. // Do executes DOMStorage.enable against the provided context.
  58. func (p *EnableParams) Do(ctx context.Context) (err error) {
  59. return cdp.Execute(ctx, CommandEnable, nil, nil)
  60. }
  61. // GetDOMStorageItemsParams [no description].
  62. type GetDOMStorageItemsParams struct {
  63. StorageID *StorageID `json:"storageId"`
  64. }
  65. // GetDOMStorageItems [no description].
  66. //
  67. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-getDOMStorageItems
  68. //
  69. // parameters:
  70. //
  71. // storageID
  72. func GetDOMStorageItems(storageID *StorageID) *GetDOMStorageItemsParams {
  73. return &GetDOMStorageItemsParams{
  74. StorageID: storageID,
  75. }
  76. }
  77. // GetDOMStorageItemsReturns return values.
  78. type GetDOMStorageItemsReturns struct {
  79. Entries []Item `json:"entries,omitempty,omitzero"`
  80. }
  81. // Do executes DOMStorage.getDOMStorageItems against the provided context.
  82. //
  83. // returns:
  84. //
  85. // entries
  86. func (p *GetDOMStorageItemsParams) Do(ctx context.Context) (entries []Item, err error) {
  87. // execute
  88. var res GetDOMStorageItemsReturns
  89. err = cdp.Execute(ctx, CommandGetDOMStorageItems, p, &res)
  90. if err != nil {
  91. return nil, err
  92. }
  93. return res.Entries, nil
  94. }
  95. // RemoveDOMStorageItemParams [no description].
  96. type RemoveDOMStorageItemParams struct {
  97. StorageID *StorageID `json:"storageId"`
  98. Key string `json:"key"`
  99. }
  100. // RemoveDOMStorageItem [no description].
  101. //
  102. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-removeDOMStorageItem
  103. //
  104. // parameters:
  105. //
  106. // storageID
  107. // key
  108. func RemoveDOMStorageItem(storageID *StorageID, key string) *RemoveDOMStorageItemParams {
  109. return &RemoveDOMStorageItemParams{
  110. StorageID: storageID,
  111. Key: key,
  112. }
  113. }
  114. // Do executes DOMStorage.removeDOMStorageItem against the provided context.
  115. func (p *RemoveDOMStorageItemParams) Do(ctx context.Context) (err error) {
  116. return cdp.Execute(ctx, CommandRemoveDOMStorageItem, p, nil)
  117. }
  118. // SetDOMStorageItemParams [no description].
  119. type SetDOMStorageItemParams struct {
  120. StorageID *StorageID `json:"storageId"`
  121. Key string `json:"key"`
  122. Value string `json:"value"`
  123. }
  124. // SetDOMStorageItem [no description].
  125. //
  126. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMStorage#method-setDOMStorageItem
  127. //
  128. // parameters:
  129. //
  130. // storageID
  131. // key
  132. // value
  133. func SetDOMStorageItem(storageID *StorageID, key string, value string) *SetDOMStorageItemParams {
  134. return &SetDOMStorageItemParams{
  135. StorageID: storageID,
  136. Key: key,
  137. Value: value,
  138. }
  139. }
  140. // Do executes DOMStorage.setDOMStorageItem against the provided context.
  141. func (p *SetDOMStorageItemParams) Do(ctx context.Context) (err error) {
  142. return cdp.Execute(ctx, CommandSetDOMStorageItem, p, nil)
  143. }
  144. // Command names.
  145. const (
  146. CommandClear = "DOMStorage.clear"
  147. CommandDisable = "DOMStorage.disable"
  148. CommandEnable = "DOMStorage.enable"
  149. CommandGetDOMStorageItems = "DOMStorage.getDOMStorageItems"
  150. CommandRemoveDOMStorageItem = "DOMStorage.removeDOMStorageItem"
  151. CommandSetDOMStorageItem = "DOMStorage.setDOMStorageItem"
  152. )