baz v0.0.17

Baz.VenueAdapter behaviour (baz v0.0.17)

Link to this section Summary

Types

address()
collection()
collection_slug()
fetch_collection_asset_page_by_slug_result()
fetch_collection_by_slug_result()
fetch_collection_event_page_by_slug_result()
page_cursor()
shared_errors()
slug_mask()
start_venue_web_socket_result()
subscribe_venue_web_socket_result()
token_id()
token_ids()
venue()

Callbacks

fetch_collection_asset_page_by_slug(venue, collection_slug, token_ids, page_cursor)
fetch_collection_by_slug(venue, collection_slug)
fetch_collection_event_page_by_slug(venue, collection_slug, token_ids, page_cursor)
start_venue_web_socket(venue)
subscribe_venue_web_socket(venue, slug_mask)

Functions

fetch_collection_asset_page_by_slug(venue, slug, token_ids, page_cursor)
fetch_collection_by_slug(venue, slug)
fetch_collection_event_page_by_slug(venue, slug, token_ids, page_cursor)

Link to this section Types

Link to this type

address()

@type address() :: String.t()
Link to this type

collection()

@type collection() :: Baz.Collections.Collection.t()
Link to this type

collection_slug()

@type collection_slug() :: String.t()
Link to this type

fetch_collection_asset_page_by_slug_result()

@type fetch_collection_asset_page_by_slug_result() ::
  Baz.Page.t() | {:error, shared_errors()}
Link to this type

fetch_collection_by_slug_result()

@type fetch_collection_by_slug_result() :: collection() | {:error, shared_errors()}
Link to this type

fetch_collection_event_page_by_slug_result()

@type fetch_collection_event_page_by_slug_result() ::
  Baz.Page.t() | {:error, shared_errors()}
Link to this type

page_cursor()

@type page_cursor() :: Baz.Page.cursor()
Link to this type

shared_errors()

@type shared_errors() :: :not_implemented | {:unhandled, term()} | term()
Link to this type

slug_mask()

@type slug_mask() :: String.t()
Link to this type

start_venue_web_socket_result()

@type start_venue_web_socket_result() :: term()
Link to this type

subscribe_venue_web_socket_result()

@type subscribe_venue_web_socket_result() :: term()
Link to this type

token_id()

@type token_id() :: non_neg_integer()
Link to this type

token_ids()

@type token_ids() :: [token_id()]
Link to this type

venue()

@type venue() :: Baz.Venues.Venue.t()

Link to this section Callbacks

Link to this callback

fetch_collection_asset_page_by_slug(venue, collection_slug, token_ids, page_cursor)

@callback fetch_collection_asset_page_by_slug(
  venue(),
  collection_slug(),
  token_ids(),
  page_cursor()
) ::
  fetch_collection_asset_page_by_slug_result()
Link to this callback

fetch_collection_by_slug(venue, collection_slug)

@callback fetch_collection_by_slug(venue(), collection_slug()) ::
  fetch_collection_by_slug_result()
Link to this callback

fetch_collection_event_page_by_slug(venue, collection_slug, token_ids, page_cursor)

@callback fetch_collection_event_page_by_slug(
  venue(),
  collection_slug(),
  token_ids(),
  page_cursor()
) ::
  fetch_collection_event_page_by_slug_result()
Link to this callback

start_venue_web_socket(venue)

@callback start_venue_web_socket(venue()) :: start_venue_web_socket_result()
Link to this callback

subscribe_venue_web_socket(venue, slug_mask)

@callback subscribe_venue_web_socket(venue(), slug_mask()) ::
  subscribe_venue_web_socket_result()

Link to this section Functions

Link to this function

fetch_collection_asset_page_by_slug(venue, slug, token_ids, page_cursor)

@spec fetch_collection_asset_page_by_slug(
  venue(),
  collection_slug(),
  token_ids(),
  page_cursor()
) ::
  fetch_collection_asset_page_by_slug_result()
Link to this function

fetch_collection_by_slug(venue, slug)

@spec fetch_collection_by_slug(venue(), collection_slug()) ::
  fetch_collection_by_slug_result()
Link to this function

fetch_collection_event_page_by_slug(venue, slug, token_ids, page_cursor)

@spec fetch_collection_event_page_by_slug(
  venue(),
  collection_slug(),
  token_ids(),
  page_cursor()
) ::
  fetch_collection_event_page_by_slug_result()