caches

Documentation

Index

• type ClansSummaries
  • func (c *ClansSummaries) GetClansSummaries(db models.DB, gameID string, publicIDs []string) ([]map[string]interface{}, error)

Types

type ClansSummaries

type ClansSummaries struct {
	// Cache points to an instance of gocache.Cache used as the backend cache object.
	Cache *gocache.Cache
}

ClansSummaries represents a cache for the RetrieveClansSummaries operation.

func (*ClansSummaries) GetClansSummaries

func (c *ClansSummaries) GetClansSummaries(db models.DB, gameID string, publicIDs []string) ([]map[string]interface{}, error)

GetClansSummaries is a cache in front of models.GetClansSummaries() with the exact same interface. Like models.GetClansSummaries(), this function may return partial results + CouldNotFindAllClansError. The map[string]interface{} return type represents a summary of one clan with the following keys/values: "membershipCount": int "publicID": string "metadata": map[string]interface{} (user-defined arbitrary JSON object with clan metadata) "name": string "allowApplication": bool "autoJoin": bool TODO(matheuscscp): replace this map with a richer type