ExClubhouse v0.6.0 ExClubhouse.Api.Search View Source
Search API
Link to this section Summary
Link to this section Functions
Link to this function
search(search_input)
View Sourcesearch(ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.SearchResults.t()} | {:error, ExClubhouse.Error.t()}
Search epics and stories
## Example
iex> ExClubhouse.Api.Search.search(%ExClubhouse.Model.Input.Search{..})
{:ok, %{ExClubhouse.Model.SearchResults{epics: ..., stories: ...}}}
Link to this function
search(session, search_input)
View Sourcesearch(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.SearchResults.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
search_epics(search_input)
View Sourcesearch_epics(ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.EpicSearchResults.t()} | {:error, ExClubhouse.Error.t()}
Search epics
## Example
iex> ExClubhouse.Api.Search.search_epics(%ExClubhouse.Model.Input.Search{..})
{:ok, %{ExClubhouse.Model.EpicSearchResults{epics: ..., stories: ...}}}
Link to this function
search_epics(session, search_input)
View Sourcesearch_epics(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.EpicSearchResults.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
search_stories(search_input)
View Sourcesearch_stories(ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.StorySearchResults.t()} | {:error, ExClubhouse.Error.t()}
Search stories
## Example
iex> ExClubhouse.Api.Search.search_stories(%ExClubhouse.Model.Input.Search{..})
{:ok, %{ExClubhouse.Model.StorySearchResults{epics: ..., stories: ...}}}
Link to this function
search_stories(session, search_input)
View Sourcesearch_stories(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Search.t()) :: {:ok, ExClubhouse.Model.StorySearchResults.t()} | {:error, ExClubhouse.Error.t()}