Ginger.Request

Requests

Here are some examples of how you might get Ginger resources.

import Ginger.Request as Request
    exposing
        ( Ordering(..)
        , QueryParam(..)
        , SortField(..)
        )


query : Cmd Msg
query =
    Request.resourceQuery GotSearchResults
        [ Text "amsterdam" ]


events : Cmd Msg
events =
    Request.resourceQuery GotEvents
        [ Upcoming
        , HasCategory Event
        , SortBy StartDate Asc
        ]

resourceById : (Result Error (Resource WithEdges) -> msg) -> ResourceId -> Cmd msg

request : (Http.Request Http.Error Resource -> msg) -> Ginger.Id.ResourceId -> Cmd msg
request toMsg id =
    Request.resourceById toMsg id

resourceByPath : (Result Error (Resource WithEdges) -> msg) -> String -> Cmd msg

request : (Http.Request Http.Error Resource -> msg) -> Cmd msg
request toMsg =
    Request.resourceByPath toMsg "/news"

resourceByName : (Result Error (Resource WithEdges) -> msg) -> String -> Cmd msg

request : (Http.Request Http.Error Resource -> msg) -> Cmd msg
request toMsg =
    Request.resourceByName toMsg "home"

resourceQuery :

(Result Error (Results (Resource WithEdges)) -> msg)

-> List QueryParam

-> Cmd msg

request : Http.Request Http.Error (List Resource)
request =
    Request.resourceQuery [ Text "amsterdam" ]

locationQuery :

(Result Error (Results Location) -> msg)

-> List QueryParam

-> Cmd msg

Search

type alias Results a =

{ results : List a

, facets : Value

, total : Int

}

type QueryParam

= ExcludeCategory Category

| Facet String

| Filter String Operator String

| HasCategory Category

| IsUnfinished

| IsUpcoming

| Limit Int

| Offset Int

| PromoteCategory Category

| SortBy SortField Ordering

| Text String

| Custom String String

Some of these params only work if mod_elasticsearch is enabled

type Ordering

= Asc

| Desc

type SortField

= PublicationDate

| StartDate

type Operator

= EQ

| LTE

| LT

| GT

| GTE

| MatchPhrase

queryParamsToBuilder : List QueryParam -> List QueryParameter

Convert this modules QueryParm to elm/url QueryParameter values to use with Url.Builder.

driebit/elm-ginger/1.0.0

Ginger.Request

Requests

Search

Modules