index.md 4.09 KB
Newer Older
MickeyMoz's avatar
MickeyMoz committed
1
2
3
4
[android-components](../../index.md) / [mozilla.components.browser.state.action](../index.md) / [SearchAction](./index.md)

# SearchAction

MickeyMoz's avatar
MickeyMoz committed
5
`sealed class SearchAction : `[`BrowserAction`](../-browser-action.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt#L754)
MickeyMoz's avatar
MickeyMoz committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

[BrowserAction](../-browser-action.md) implementations related to updating search engines in [SearchState](../../mozilla.components.browser.state.state/-search-state/index.md).

### Types

| Name | Summary |
|---|---|
| [AddSearchEngineListAction](-add-search-engine-list-action/index.md) | `data class AddSearchEngineListAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to add/modify [SearchState.searchEngines](../../mozilla.components.browser.state.state/-search-state/search-engines.md). |
| [RemoveCustomSearchEngineAction](-remove-custom-search-engine-action/index.md) | `data class RemoveCustomSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to remove a custom [SearchEngine](../../mozilla.components.browser.state.search/-search-engine/index.md). |
| [SetCustomSearchEngineAction](-set-custom-search-engine-action/index.md) | `data class SetCustomSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to add/modify a custom [SearchEngine](../../mozilla.components.browser.state.search/-search-engine/index.md). |
| [SetDefaultSearchEngineAction](-set-default-search-engine-action/index.md) | `data class SetDefaultSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to update [SearchState.defaultSearchEngineId](../../mozilla.components.browser.state.state/-search-state/default-search-engine-id.md). |

### Extension Functions

| Name | Summary |
|---|---|
| [loadResourceAsString](../../mozilla.components.support.test.file/kotlin.-any/load-resource-as-string.md) | `fun `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`.loadResourceAsString(path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Loads a file from the resources folder and returns its content as a string object. |

### Inheritors

| Name | Summary |
|---|---|
| [AddSearchEngineListAction](-add-search-engine-list-action/index.md) | `data class AddSearchEngineListAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to add/modify [SearchState.searchEngines](../../mozilla.components.browser.state.state/-search-state/search-engines.md). |
| [RemoveCustomSearchEngineAction](-remove-custom-search-engine-action/index.md) | `data class RemoveCustomSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to remove a custom [SearchEngine](../../mozilla.components.browser.state.search/-search-engine/index.md). |
| [SetCustomSearchEngineAction](-set-custom-search-engine-action/index.md) | `data class SetCustomSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to add/modify a custom [SearchEngine](../../mozilla.components.browser.state.search/-search-engine/index.md). |
| [SetDefaultSearchEngineAction](-set-default-search-engine-action/index.md) | `data class SetDefaultSearchEngineAction : `[`SearchAction`](./index.md)<br>Updates [BrowserState.search](../../mozilla.components.browser.state.state/-browser-state/search.md) to update [SearchState.defaultSearchEngineId](../../mozilla.components.browser.state.state/-search-state/default-search-engine-id.md). |